/docs/services/ Recent content in Services 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/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/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/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