/ Recent content in Introduction on CPS IoT Ready Hugo -- gohugo.io en-us /docs/services/access/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/access/ Access service # Service namespace: access Responsible for giving access to identities from NFC or BLE and controlling lock and display. Configuration # Config json schema available on api/v1/device/<dev_id>/service/access/config/schema: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/access/config/schema Field Type Description enable bool Enable access control open_access bool Set to true to allow any identity decline_notify bool Report declined access events operator string Operator customization caption string Caption text below image language string Language for messages. /docs/services/autoclose/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/autoclose/ Autoclose service # Service namespace: autoclose Service for managing automatic opening hours for the container. If outside opening hours, the container will be fully closed, rejecting both access cards and the keep-unlocked setting. Configuration # Config json schema available on api/v1/device/<dev_id>/service/autoclose/config/schema: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/autoclose/config/schema Field Type Description timezone string IANA Timezone string, e.g. Europe/Oslo, for where the device is lSet to true to allow any identityocated close_rules array Up to 8 rules for when the device should lock. /docs/services/battery/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/battery/ Battery service # Service namespace: battery Reports battery status. Messages # Status # Message name: status Field Type Description nom_v float Nominal Voltage min_v float Minimum Voltage temp float Temperature Read message: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/battery/message/status /docs/services/dis/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/dis/ Display service # Service namespace: dis Configuration # Config json schema available on api/v1/device/<dev_id>/service/dis/config/schema: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/dis/config/schema Field Type Description intensity integer Intensity in percent rotation object Rotation rotation.angle integer Rotation angle in either 0, 90, 180 or 270 degrees Read config with status: curl -H "X-IOTREADY-CONFIG-NEXT-GEN: true" -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/dis/config Configure display rotation: curl -H "X-API-Key: <api key>" -X PUT -d '{"rotation":{"angle":270}}' \ https://api. /docs/services/hut/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/hut/ Humidity/temperature service # Service namespace: hut Reports events based on humidity/temperature measurements. Messages # Event # Message name: event Field Type Description time timestamp UTC time of event report object Report report.temperature int Temperature in °C report.humidity int Relative humidity in percent /docs/services/imug/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/imug/ Inertial Measurement Unit (With gyro) service # Service namespace: imug Reports events based on movement Messages # Event # Message name: event Field Type Description time timestamp UTC time of event motion object Motion detected motion.dt_s int Motion event duration in seconds /docs/bestpractices/integrator/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/bestpractices/integrator/ Integrator best practices # Use built-in metadata storage for device # The device object have a limited size external field. This can be used for a integrator json object. This allows the integrator to avoid having it’s own device database. And can simplify design. Set this field: curl -H "X-API-Key: <api key>" -X PUT -H "Content-Type: application/json" \ -d '{"customer":"customer1","group":"group1"}' \ https://api.nr.iotready.no/api/v1/device/<dev_id>/external The devices endpoint allows queries using external fields: /docs/api/intro/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/api/intro/ Introduction # Endpoints # APIs are served by the api.nr.iotready.no domain. REST URL: https://api.nr.iotready.no/api/v1 MQTT URL: mqtts://api.nr.iotready.no/v1 See MQTT chapter for details on MQTT connection. Content Types # All API content type is json unless specified. It’s recommended to specify Content-Type: application/json, but it’s not a requirement as it’s expected as default. Content type can be set like this: curl -H "Content-Type: application/json" \ https://api.nr.iotready.no/api/v1/device/123 For PATCH operations the default is Content-Type: application/merge-patch+json. /docs/services/location/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/location/ Location service # Service namespace: location Responsible for reporting location. Configuration # Config json schema available on api/v1/device/<dev_id>/service/location/config/schema: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/location/config/schema Field Type Description enable bool Enable position retrieval interval_s int Interval in seconds between retrieving position timeout_s int Timeout in seconds trying to get position fix movement object Movement triggered position retrieval movement.enable bool Enable movement triggered position retrieval Read config with status: curl -H "X-IOTREADY-CONFIG-NEXT-GEN: true" -H "X-API-Key: <api key>" \ https://api. /docs/services/lock/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/lock/ Lock service # Service namespace: lock Configuration # Config json schema available on api/v1/device/<dev_id>/service/lock/config/schema: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/lock/config/schema Fields nolock, bistable, monostable, emz_flex, emz_payt, kerong and nrcl are oneof type. Field Type Description enable bool Enable/disable lock functionality close_timeout_s integer Close timeout in seconds keep_unlocked bool Keep in unlocked state nolock object No lock bistable object Bistable lock type bistable.hold_ms integer Hold time in ms monostable object Monostable lock type monostable. /docs/services/mag/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/mag/ Magnetic sensor service # Service namespace: mag Reports events on magnetic sensor threshold. Messages # Event # Message name: event Field Type Description time timestamp UTC time of event pulse object Pulse detected pulse.dt_s int Pulse length in seconds /docs/services/modem/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/modem/ Modem service # Service namespace: modem Configuration # Config json schema available on api/v1/device/<dev_id>/service/modem/config/schema: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/modem/config/schema Field Type Description interval int Interval in seconds between scheduled connection uestats bool Enable/disable reporting of uestats message Read config with status: curl -H "X-IOTREADY-CONFIG-NEXT-GEN: true" -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/modem/config Configure interval to 1 hour: curl -H "X-API-Key: <api key>" -X PUT -d '{"interval":3600}' \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/modem/config/value Messages # UEStats # Message name: uestats /docs/arch/nbiot/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/arch/nbiot/ NB IoT # NB IoT is a protocol designed for low data usage and low power usage, and can give years of battery operated usage. But this implies some constraints: Not always connected. The device will initiate communication, and any data to the device can have long latencies (configurable from seconds to days). Number of communication sequences can be limited to adhere battery limits or data usage limits. Meaning large data transfers might be distributed over days to conform to such requirements. /docs/services/nfc_uid_acl/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/nfc_uid_acl/ NFC UID Access Control List service # Service namespace: nfc_uid_acl Configuration # Config json schema available on api/v1/device/<dev_id>/service/nfc_uid_acl/config/schema: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/nfc_uid_acl/config/schema Field Type Description enable bool Enable/disable uids string list List of allowed NFC UIDs. Encoded as a hexadecimal string Read legacy config: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/nfc_uid_acl/config Configure access list: curl -H "X-API-Key: <api key>" -X PUT \ -d '{"enable":true,"uids":["12345678","ABCDEF00"]}' \ https://api.nr.iotready.no/api/v1/device/<dev_id>/service/nfc_uid_acl/config /docs/products/nrc1/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/products/nrc1/ NRC1 # NRC1 is a access controller for electronic locks. Features: NB-IoT connectivity Bluetooth Supports a variety of electronic locks NFC reader Colour display Modules # NRC1 is assembled from four generic modules. None of them is specific to NRC1: each has its own repository, release cycle and version, and is shared with the other products that use it. Module Role in NRC1 gw Gateway. The NB-IoT modem and cloud link, Bluetooth, the lock driver, and the MIB controller the other three answer to nfc The NFC reader dis The colour display sun The sensor unit The service table below does not line up one-to-one with this list — it names six services across the modules and none of sun’s. /docs/services/ran/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/services/ran/ Range service # Service namespace: ran Messages # Event # Message name: event Field Type Description time timestamp UTC time of event range object Range data range.rows object array Range rows range.rows.distances_mm int array Array of measurement values in mm. 0 represents measurement failed /docs/api/auth/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/api/auth/ Authentication # For an API key contact your IoT Ready administrator. For REST use the supplied API key in http header X-API-Key curl -H "X-API-Key: <api key>" https://api.nr.iotready.no/api/v1/device/123 For MQTT use X-API-Key as username and api key as password. mosquitto_sub -v --capath /etc/ssl/certs \ -L "mqtts://X-API-Key:<api key>@api.nr.iotready.no/v1/upstream/#" See MQTT chapter for details on MQTT connection. /docs/products/nrc2/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/products/nrc2/ NRC2 # NRC2 is a fill level sensor. Features: NB-IoT connectivity Bluetooth Time-of-Flight (ToF) multi-zone sensor. 8x8 matrix with 63° diagonal FoV Movement sensor Magnetic proximity sensor Config # Config json schema available on api/v1/device/<dev_id>/config/schema: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/<dev_id>/config/schema Field Type Description modem object modem configuration modem.interval int Interval in seconds between scheduled connection ran object object ran.enable bool Enable range sensor ran.interval_s int Interval in seconds between range measurements imug object Inertial Measurement Unit configuration imug. /docs/api/product/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/api/product/ Product # Devices are grouped in products with different functionality. A product supports a given set of services. List Products # To get a list of available products: curl -H "X-API-Key: <api key>" https://api.nr.iotready.no/api/v1/products Response: { "products": [ { "name": "product1" }, { "name": "product2" } ] } Get Product # Get information on a single product: curl -H "X-API-Key: <api key>" https://api.nr.iotready.no/api/v1/product/product1 Get Product Devices # Get a list of devices for a given product: /docs/api/device/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/api/device/ Device # Device (api/v1/device) # Access to device object. For accessing list of devices see Multiple Devices section. curl -H "X-API-Key: <api key>" https://api.nr.iotready.no/api/v1/device/123 Device object fields: Field Type Description created timestamp UTC time of device object creation updated timestamp UTC time of device object update dev_id string Unique device ID product string Product ID. To differentiate between different products variant string Non-functional variations within same product hw_version string Device hardware version status object Current status. /docs/api/service/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/api/service/ Service # Service object: Field Type Description name string Unique name of service config object Config object messages object array Array of Message objects All services # List all the services for a device: curl -H "X-API-Key: <api key>" \ https://api.nr.iotready.no/api/v1/device/123/services Service # Each service is addressed under the device api under the path api/v1/device/<dev_id>/service/<service namespace>. See Services for available services. Config # Config object: Field Type Description updated timestamp UTC time of update from API state string State of configuration sync value object Config value Any service config can be addressed on: api/v1/device/<dev_id>/service/<service namespace>/config /docs/api/manuf/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/api/manuf/ Manufacturer (api/v1/item) # Manufacturer specific device endpoint: Specific authorization Only access to set production and initial device data Object: Name Type Description dev_id string state DeviceState Device state product string Product name. A unique identifier for same functionality variant string Product variant. Non-functional variations within same product hw_version string Hardware version firmwares FirmwaresEntry Firmware versions modem Modem Modem details sim SIM SIM details manufacturer string Manufacturer name packaging PackagingEntry Packaging associations prod_meta Struct Other production data test_results Struct Test results /docs/api/mqtt/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/api/mqtt/ MQTT # Broker specification: MQTT v3.1.1 QoS 0 and 1 Connection details: Host: api.nr.iotready.no Uses TLS with CA-signed certificate TLS secured Port: 8883 Username: X-API-Key Password: your api key Topic prefix required: v1 Topics: v1/upstream: Messages Example: shell mosquitto_sub -v \ -L "mqtts://X-API-Key:<api key>@api.nr.iotready.no/v1/upstream/#" python import paho.mqtt.client as mqtt def on_connect(client, userdata, flags, rc): print("Connected with result code "+str(rc)) client.subscribe("v1/upstream/#") def on_message(client, userdata, msg): print(msg.topic+" "+str(msg.payload)) client = mqtt.Client() client. /messages/item/ Mon, 01 Jan 0001 00:00:00 +0000 /messages/item/ Name Type Description dev_id string state DeviceState Device state product string Product name. A unique identifier for same functionality variant string Product variant. Non-functional variations within same product hw_version string Hardware version firmwares FirmwaresEntry Firmware versions modem Modem Modem details sim SIM SIM details manufacturer string Manufacturer name packaging PackagingEntry Packaging associations prod_meta Struct Other production data test_results Struct Test results