Skip to content

As OWNER of an organization, I want to register a new sensor #22

@uliSchuster

Description

@uliSchuster

As organization OWNER, I have a sensor node of a type that is supported by the Clair Platform (currently, these are the Elsys ERS CO2 and ERS CO2 Lite models only). I want to use this sensor node with the Clair Platform.
Registration comprises three steps, as currently implemented in the TTN Node Management Tools:

  1. Register the node with the appropriate application of The Things Network and generate a JOIN key.
  2. Parameterize the node with the JOIN key and all other parameters to interoperate correctly with our TTN application.
  3. Create a Managair inventory model of the sensor node and associate it with the user's organization.

A simplified usage scenario might look as follows:

  1. The OWNER opens the Clair Dashboard, authenticates, and selects "Add new sensor" from the menu.
  2. A dialog opens to select the sensor maker (currently Elsys only), the model (ERS CO2 or ERS CO2 Lite), and the device EUI. The user must type the device EUI (no support for reading QR codes and the like for now), which the Clair Dashboard validates: Via the built-in checksum, and against devices already registered on the platform.
  3. The Dashboard calls a Managair API service that in turn uses a yet-to-be-implemented platform application that interfaces with the TTN management API (or the Managair does this directly - t.b.d.) and thus registers the device with the clair-berlin-ers-co2 application. This application essentially performs:
    1. Device registration, as currently implemented in the clair-register-device-in-ttn command-line script.
    2. Creation of device configuration data, as currently implemented in the clair-generate-nfc-config command-line script.
  4. The Dashboard displays the configuration data for download, either as QR code or text data. It also shows a link to the Clair website, where the user can find additional instructions on how to configure the Elsys sensor nodes via an NFC app on their smartphone.
  5. The user then configures the sensor node via NFC. This triggers a reboot and a LoRaWAN OTAA JOIN.
  6. Once the JOIN succeeds, TTN publishes an MQTT device activation message. The yet-to-be-implemented platform application receives this message, ensures that the device is not yet registered with the Managair, and then registers the device via the Managair API, as currently implemented in the clair-register-device-in-managair command-line script.
  7. Upon registering a new device with an organization, the Managair should inform the organisation's OWNER; e.g., via email.

Issues to consider:

  • The node must be new. If the node ID has already been registered before, or is currently registered with another organization, automatic registration must not be possible. Instead, the organization OWNER should see an error message to contact the Clair operations team. Transferring a registered sensor from one organization to another must be performed in the Admin UI currently.
  • Currently, TTN runs on the V2 Stack. The new V3 Stack, which is supposed to be deployed shortly, features a new API. Since the APIs are quite different, we either need to encapsulate the TTN servers, or wait until the V3 Stack is ready for production use.

Complexity: 30
Value: 30
WSJF: 1

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions