Skip to main content

Peripheral Schema

Xenial Cloud Portal 4-Dot Menu Data Management Ordering Settings Hardware Peripheral Schema

To create a peripheral schema:

  1. From the upper-right of the Peripheral Schema area, select New Peripheral Schema.

  2. In the Name field, type the name of the peripheral device schema.

  3. From the Type dropdown, select the applicable schema type.

  4. In the Schema field, type the peripheral schema in JSON data format.

  5. From the upper-right of the screen, select Save.

Create Custom Peripheral Schema

To create a custom peripheral schema:

  1. From the upper-right of the Peripheral Schema area, select New Peripheral Schema.

  2. In the Name field, type the name of the peripheral device schema.

  3. From the Type dropdown, select Device.

  4. In the Schema field, copy/paste the following code:

    { "type": "object", "properties": { "name": { "description": "Name", "type": "string", "minLength": 1 }, "adapter_url": { "description": "The URL link to the custom adapter.", "type": "string", "maxLength": 1024, "minLength": 1 }, "options": { "description": "Configuration payment adapter in JSON format.", "type": "string", "minLength": 1, "maxLength": 2048 }, "adapter_type": { "description": "Adapter Type", "type": "string", "oneOf": [ { "enum": [ "lan" ], "description": "LAN" }, { "enum": [ "websocket" ], "description": "Windows Device Bridge" }, { "enum": [ "bluetooth" ], "description": "Bluetooth" } ], "default": "lan" }, "device_type": { "description": "Device Type", "type": "string", "oneOf": [ { "enum": [ "payment" ], "description": "Payment Device" } ], "default": "payment" }, "connection_type": { "description": "Connection Type", "type": "string", "oneOf": [ { "enum": [ "lan" ], "description": "LAN" }, { "enum": [ "opos" ], "description": "OPOS" }, { "enum": [ "bluetooth" ], "description": "Bluetooth" } ], "default": "lan" } }, "required": [ "name", "adapter_url", "options", "adapter_type", "device_type", "connection_type" ] }

  5. From the upper-right of the screen, select Save.

See Also