id: Each SHIP node has a global unique SHIP ID. The SHIP ID is used to uniquely identify a SHIP node, e.g. in its service discovery. This ID is present in the mDNS/DNS-SD local service discovery. ID of the SHIP node has a maximum length of 63 bytes. The first part of the unique ID SHOULD be an abbreviation of the manufacturer name. Behind the abbreviation the manufacturer defines a unique identifier by itself. The id value should be as unique as possible.
ski: Each SHIP node has a specific public key. The Subject Key Identifier (SKI) is derived from this public key and is used as cryptographically backed identification and authentication criterion. The SKI key allows other SHIP nodes to directly identify a SHIP node by its SKI. This is very helpful for other SHIP nodes that were provided with one or more trustworthy SKI values from other SHIP nodes via "commission tool", "user verification" or "user input".
SHIP Network Control
Mode
Normal: SHIP Node autoaccept mode is disabled.
Pairing: SHIP Node autoaccept mode is enabled for default pairing duration.
Removing: Removes SHIP Node.
Operations:
getModeDuration: Gets duration for specific mode in milliseconds. 0 indicates infinite duration.
setModeDuration: Sets duration for specific mode in milliseconds. 0 indicates infinite duration.
Reset: Resets network controller.
SHIP External Device
Properties
brand: Brand of device that represents current SHIP node. Maximum 32 byte of UTF-8 data.
hostName: DNS hostname of SHIP node.
id: Each SHIP node has a global unique SHIP ID. The SHIP ID is used to uniquely identify a SHIP node, e.g. in its service discovery. This ID is present in the mDNS/DNS-SD local service discovery. ID of the SHIP node has a maximum length of 63 bytes. The first part of the unique ID SHOULD be an abbreviation of the manufacturer name. Behind the abbreviation the manufacturer defines a unique identifier by itself. The id value should be as unique as possible.
model: Model of device that represents current SHIP node. Maximum 32 byte of UTF-8 data.
path: String with wss path. The maximum length of the path value will be 32 byte of UTF-8 data. The minimum length is 1, where the path key contains the value "/".
port: TCP server port of SHIP node.
ski: Each SHIP node has a specific public key. The Subject Key Identifier (SKI) is derived from this public key and is used as cryptographically backed identification and authentication criterion. The SKI key allows other SHIP nodes to directly identify a SHIP node by its SKI. This is very helpful for other SHIP nodes that were provided with one or more trustworthy SKI values from other SHIP nodes via "commission tool", "user verification" or "user input".
SHIP Pairing Control
pair - this operation should be executable only when the SHIP device status is NOT_CONFIGURED. The operation will try to establish initial connection to the external SHIP node.
If the operation completes successfully, the SHIP device will change its status to ONLINE.
If the connection is not possible, then the operation will throw an exception and the SHIP device status will remain NOT_CONFIGURED or the device will be removed if the SHIP node becomes undiscoverable via mDNS.
unpair - this operation executes only when the SHIP device was paired before and the SHIP device status is not NOT_CONFIGURED. The operation close any open connections to the remote SHIP node, clear the persistent data that the device was once paired and not accept any incoming connection requests from the remote SHIP node.
