Using the device Command Set

The `device` command set contains commands used to connect devices to a profile.

Requesting a connection

The `device request` command is used on the new device to request connection to the user's profile. Alice need only specify the mesh service account to which connection is requested:

Alice2> device request
   Witness value = ASOE-FANU-WN2N-UQ24-JBHE-GSHV-EKQL

In this case there is no existing device profile and so a new profile is created and used to create a registration request which is posted to the user's account.

The tool reports the connection request authenticator, a UDF fingerprint which authenticates this particular request.

Alice must use a device already connected to her account to complete the connection process.

The `device pending` command gives a list of pending connection messages.

Alice> device pending

Alice sees the request that she posted and approves it with the connect `device accept` command:

Alice> device accept NDZP-2UYY-ZA5U-T2PR-7XBW-OBT6-2OQE

There is a second request (from Mallet) that Alice doesn't recognize. Alice rejects this request:

Alice> device reject NB3R-I5BK-QDB2-QWXG-WPVK-NGH6-OIII

The connection process is completed by synchronizing the new device. At this point, all the applications that were available to the first device are available to the second:

Alice2> device complete
ERROR - Object reference not set to an instance of an object.
Alice2> account sync
ERROR - Object reference not set to an instance of an object.

Managing connected devices

The `device list` command gives a list of devices in the device catalog:

Alice> device list

The `device delete` command removes a device from the catalog:

Alice> device delete NDZP-2UYY-ZA5U-T2PR-7XBW-OBT6-2OQE
ERROR - The feature has not been implemented
Alice> device list

Requesting a connection using a PIN

The simple connection mechanism is straightforward but relies on the user who is processing the connection requests recognizing the correct fingerprint. While this is approach has proved practical when it is the same user who is making and approving the connection request, it is less satisfactory when this is done by two different people or by the same person at different times.

Connection requests may be authenticated by means of a PIN created on an administration device. The `device pin` command generates a new PIN code:

Alice> account pin
PIN=NARV-QGFB-7LZ2-6IYI-KE (Expires=2019-11-14T20:27:54Z)

The pin code can now be used to authenticate the connection request:

Alice3> device request /pin=NARV-QGFB-7LZ2-6IYI-KE
   Witness value = 6X26-DOD7-HQXO-7WQZ-5VZI-HB6D-CWK3

Since the PIN code that was issued was set to be self-authorizing, the device is connected automatically when the user synchronizes their account from an administrator device:

Alice> device pending

Requesting a connection using an EARL

Encrypted Authenticated Resource Locators provide one means of preconfiguring a device to enable simple and straightforward connection to a Mesh profile.

The EARL itself is typically presented by means of a barcode on the device or its packaging. To connect the device, the user simply scans the QR code using a Mesh enabled application on an administion device and applies power. configuration then proceeds automatically.

Alternatively, the EARL may be transfered wirelessly by a near field communications link or by cycling an LED.

To enable this connection mode, the manufacturer performs the steps of

  • Encrypting the open connection request under a randomly chosen key
  • Provisioning the encrypted device profile to a Web site
  • Creating UDF EARL of the key
  • Converting the EARL to a QR code which is printed on the device or its packaging.

These steps may be performed on the device to be connected using the `device request` command with the `/earl` option. Instead of requesting connection to a user account, the device requests connection to a special purpose account established for the purpose of providing a hailing account for enabling this type of device connection.

Alice4> device pre /key=udf://
ERROR - Object reference not set to an instance of an object.

The device can attempt to complete the connection whenever it is provided with power and network connectivity using the `profile sync` command.

Alice4> account sync
ERROR - Object reference not set to an instance of an object.

The key specified in the '/earl' option is used to create a UDF EARL specifying a location from which a device description document may be obtained. Note that it is not necessary for the device description document to be on the same service or even in the same domain as the service used to resolve the UDF.

The UDF is typically presented to the user as a QR code either on the device itself or its packaging. Alternatively, a device might transmit the UDF by blinking its activity LED at a rate suitable to allow transmission of a short message to a smart phone camera.

A QR code or other scanning application can use the meshman tool to resolve the EARL and retrieve the data using the `device earl` command:

Alice> device earl udf://
ERROR - Object reference not set to an instance of an object.

The tool performs the tasks of resolving the EARL, decrypting the discovery record and posting a connection response to both the hailing account and the profile account. The next time the device polls the hailing account, it retrieves the connection data:

Alice4> account sync
ERROR - Object reference not set to an instance of an object.

Once connected to an account, a device does not attempt to poll the hailing account. Further attempts to make a connection are thus ignored unless the device is reset.