BlueRange API Reference 5.19.2
  • #asset_detection
  • #asset_tracking
  • #beacon_reporting
  • #building_automation
  • #device_management
  • #environment_profiles
  • #internal

Operations

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{estimatorUuid}/indoor/{assetUuid}/positionEstimate

    An estimated position is published by MeshGateway devices each time the position tracked gets updated. Different topic structure, but same payload as 'br/{organizationUuid}/{buildingUuid}/{floorUuid}/positionEstimate/{assetUuid}'.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    estimatorUuid
    required
    string
    uid: estimatorUuid

    identifies MeshGateway Device reporting the PositionEstimate

    assetUuid
    required
    string
    uid: assetUuid

    identifies Asset tracked

    Accepts the following message:

    PositionEstimate

    Estimated position information

    object
    uid: PositionEstimate
    • #asset_tracking

    Examples

  • SUB br/{organizationUuid}/{buildingUuid}/{floorUuid}/positionEstimate/{assetUuid}

    An estimated position is published by MeshGateway devices each time the position tracked gets updated. Different topic structure, but same payload as 'br/{organizationUuid}/{buildingUuid}/{floorUuid}/positionEstimate/{assetUuid}'.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    buildingUuid
    required
    string
    uid: buildingUuid

    identifies Building subject within Organization

    floorUuid
    required
    string
    uid: floorUuid

    identifies Floor subject within Organization

    assetUuid
    required
    string
    uid: assetUuid

    identifies Asset tracked

    Accepts the following message:

    PositionEstimate

    Estimated position information

    object
    uid: PositionEstimate
    • #asset_tracking

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{estimatorUuid}/indoor/assetTrackingState

    The state of the asset tracking system will be published, whenever it was changed by the MeshGateway which is responsible for tracking assets in the specified site. Currently, the state can only be ENABLED or DISABLED.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    estimatorUuid
    required
    string
    uid: estimatorUuid

    identifies MeshGateway Device reporting the PositionEstimate

    Accepts the following message:

    AssetTrackingStateEvent

    Current state of the asset tracking system

    restricted any
    uid: AssetTrackingStateEvent
    • #asset_tracking

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{estimatorUuid}/indoor/{assetUuid}/{geofenceUuid}/geofenceEvent

    Message published by MeshGateway devices when the entered or left state of a tracked Asset changes with respect to a Geofence defined. Different topic structure, but same payload as 'br/{organizationUuid}/{buildingUuid}/{floorUuid}/geofenceEvent/{assetUuid}/{geofenceUuid}'.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    estimatorUuid
    required
    string
    uid: estimatorUuid

    identifies MeshGateway Device reporting the GeofenceEvent

    assetUuid
    required
    string
    uid: assetUuid

    identifies Asset tracked

    geofenceUuid
    required
    string
    uid: geofenceUuid

    identifies the Geofence subject

    Accepts the following message:

    GeofenceEvent

    Geofence tracking message

    restricted any
    uid: GeofenceEvent
    • #asset_tracking

    Examples

  • SUB br/{organizationUuid}/{buildingUuid}/{floorUuid}/geofenceEvent/{assetUuid}/{geofenceUuid}

    Message published by MeshGateway devices when the entered or left state of a tracked Asset changes with respect to a Geofence defined. Different topic structure, but same payload as 'rltn-iot/{organizationUuid}/{siteUuid}/{estimatorUuid}/indoor/{assetUuid}/{geofenceUuid}/geofenceEvent'

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    buildingUuid
    required
    string
    uid: buildingUuid

    identifies Building subject within Organization

    floorUuid
    required
    string
    uid: floorUuid

    identifies Floor subject within Organization

    assetUuid
    required
    string
    uid: assetUuid

    identifies Asset tracked

    geofenceUuid
    required
    string
    uid: geofenceUuid

    identifies the Geofence subject

    Accepts the following message:

    AssetTracking

    Geofence tracking message

    restricted any
    uid: GeofenceEvent
    • #asset_tracking

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/beacon/{beaconBleAddress}/beaconData

    A message published by the BlueRange gateway, as soon as a beacon report was received from a mesh node. Beacon scanning and reporting is disabled by default and must be enabled and configured in the BlueRange admin portal.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies the mesh node that reported the scanned beacon

    beaconBleAddress
    required
    string
    uid: beaconBleAddress

    identifies the scanned beacon by its BLE address. Note, that the colons in the BLE address are omitted in the MQTT topic, i.e. 001122334455 is used instead of 00:11:22:33:44:55

    Accepts the following message:

    BeaconReport

    Beacon report message

    restricted any
    uid: BeaconReport
    • #beacon_reporting

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}//beacon//beaconBatch

    A message published by the BlueRange gateway that contains a (gzip compressed) batch of beacon reports intended to reduce the MQTT traffic. In order to receive messages, the feature "beacon scanning and reporting" must be enabled on the gateway policy with MQTT Message Batching enabled.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    Accepts the following message:

    BeaconReportBatch

    Beacon report batch message

    restricted any
    uid: BeaconReportBatch
    • #beacon_reporting

    Examples

  • PUB rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/actuator/{actuatorType}/{actuatorIndex}/actuatorData

    Client applications may publish setpoint values for actioning an actuator. Live feedback of sensor data needs to be processed to find out whether actioning succeeded.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization operated in

    siteUuid
    required
    string
    uid: siteUuid

    network the controlled device belongs to and where the environment profile data is read from

    deviceUuid
    required
    string
    uid: deviceUuid

    controlled device the actuator is attached to

    actuatorType
    required
    string
    uid: actuatorType

    type of actuator, such as driveUp

    actuatorIndex
    required
    integer
    format: int32uid: actuatorIndex

    index of the actuator to control such as lamp head #0, #1, etc.

    Accepts the following message:

    ActuatorData

    controls an actuator supplying a setpoint value

    restricted any
    uid: ActuatorData
    • #building_automation

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/indicator/{indicatorType}/{indicatorIndex}/indicatorData

    The MeshGateway publishes an IndicatorData message whenever a connected device reports a matching state indication.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies mesh node reporting the IndicatorData

    indicatorType
    required
    string
    uid: indicatorType

    type of indicator, such as MOTOR_FAILURE

    indicatorIndex
    required
    integer
    format: int32uid: indicatorIndex

    identifies the concrete indicator, such as a motor 1..4

    Accepts the following message:

    IndicatorData

    Indicator notification

    restricted any
    uid: IndicatorData
    • #building_automation

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{beaconUuid}/sensor/{sensorType}/{sensorIndex}/sensorData

    The MeshGateway publishes a SensorData message whenever the measurement value of a sensor connected to some Beacon changes. Different topic structure, but same payload as 'br/{organizationUuid}/{buildingUuid}/{floorUuid}/{roomUuid}/sensorData/{sensorType}'

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    beaconUuid
    required
    string
    uid: beaconUuid

    identifies mesh node Device reporting the SensorData

    sensorType
    required
    string
    uid: sensorType

    type of sensor, such as presence

    sensorIndex
    required
    integer
    format: int32uid: sensorIndex

    identifies the concrete sensor, such as a lamp head index 1..4

    Accepts the following message:

    SensorData

    Sensor raw value change notification

    restricted any
    uid: SensorData
    • #building_automation

    Examples

  • SUB br/{organizationUuid}/{buildingUuid}/{floorUuid}/{roomUuid}/sensorData/{sensorType}

    The MeshGateway publishes a SensorData message whenever the measurement value of a sensor connected to some Beacon changes. Different topic structure, but same payload as 'rltn-iot/{organizationUuid}/{siteUuid}/{beaconUuid}/sensor/{sensorType}/{sensorIndex}/sensorData'

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    buildingUuid
    required
    string
    uid: buildingUuid

    identifies Building subject within Organization

    floorUuid
    required
    string
    uid: floorUuid

    identifies Floor subject within Organization

    roomUuid
    required
    string
    uid: roomUuid

    identifies Room subject within Organization

    sensorType
    required
    string
    uid: sensorType

    type of sensor, such as presence

    Accepts the following message:

    SensorData

    Sensor raw value change notification

    restricted any
    uid: SensorData
    • #building_automation

    Examples

  • PUB rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/sensor///sensorRequest

    BlueRange does not use persistent retained messages. Therefore newly connecting clients do not receive up to date sensor measurements automatically. In order to support real-time clients displaying the current values, such a client may explicitly request a MeshGateway to publish the last known recent measurement values. Different topic structure, but same payload as 'br/{organizationUuid}/{buildingUuid}/{floorUuid}//sensorRequest'

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    deviceUuid
    required
    string
    uid: deviceUuid

    adresses a particular MeshGateway device of the Site

    Accepts the following message:

    SensorDataRequest

    request current SensorData measurements

    restricted any
    uid: SensorDataRequest
    • #building_automation

    Examples

  • PUB br/{organizationUuid}/{buildingUuid}/{floorUuid}//sensorRequest

    BlueRange does not use persistent retained messages. Therefore newly connecting clients do not receive up to date sensor measurements automatically. In order to support real-time clients displaying the current values, such a client may explicitly request a MeshGateway to publish the last known recent measurement values. Different topic structure, but same payload as 'rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/sensor///sensorRequest'

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    buildingUuid
    required
    string
    uid: buildingUuid

    identifies Building subject within Organization

    floorUuid
    required
    string
    uid: floorUuid

    identifies Floor subject within Organization

    Accepts the following message:

    SensorDataRequest

    request current SensorData measurements

    restricted any
    uid: SensorDataRequest
    • #building_automation

    Examples

  • PUB rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/device/${targetUuid}/identify

    Requests a target device to physically flash or blink so that one can identify the thing.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    network that is to locate the target device

    deviceUuid
    required
    string
    uid: deviceUuid

    gateway to communicate with device. This parameter is optional and can be replaced with '//'

    targetUuid
    required
    string
    uid: targetUuid

    device that is to identify itself to the human user

    Accepts the following message:

    IdentifyDeviceRequest

    request device identification

    restricted any
    uid: IdentifyDeviceRequest
    • #internal

    Examples

  • PUB rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/env/{profileType}/{profileIdButtonId}/act

    Published by clients implementing the environment profiles. E.g. TouchForLight and BlueForLight.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies Device subject within the site. This parameter is optional and can be replaced with '//'

    profileType
    required
    string
    uid: profileType

    type of the environment profile

    profileIdButtonId
    required
    string
    uid: profileIdButtonId

    identifies the profile id and the button id separated by '-'

    Accepts the following message:

    EnvironmentProfiles

    Perform actions based on environment profile

    restricted any
    uid: EnvironmentProfileRequest
    • #environment_profiles

    Examples

  • PUB rltn-iot/{organizationUuid}/{siteUuid}/{beaconUuid}/rwio/{module}/{componentRegister}/{actionReqType}

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    beaconUuid
    required
    string
    uid: beaconUuid

    identifies Beacon Device requested to act on sensors

    module
    required
    string
    uid: module

    unique string addressing a Beacon module

    componentRegister
    required
    string
    uid: componentRegister

    identifies the component (vendor-specific such as a lamp head) and register (vendor-specific such as hardware address) in the form of decimal numbers separated by '-', e.g. 32-4

    actionReqType
    required
    string
    uid: actionReqType

    either 'read', 'write' or 'writeAck'

    Accepts the following message:

    ComponentActRequest

    instructs device to read data from and/or write data into a register address

    restricted any
    uid: ComponentActRequest
    • #building_automation

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{beaconUuid}/rwio/{module}/{componentRegister}/{actionRspType}

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    beaconUuid
    required
    string
    uid: beaconUuid

    identifies Beacon Device requested to sense on sensors

    module
    required
    string
    uid: module

    unique string addressing a Beacon module

    componentRegister
    required
    string
    uid: componentRegister

    identifies the component (vendor-specific such as a lamp head) and register (vendor-specific such as hardware address) in the form of decimal numbers separated by '-', e.g. 32-4

    actionRspType
    required
    string
    uid: actionRspType

    either 'unspecified', 'errorRsp', 'readRsp', 'writeRsp'

    Accepts the following message:

    ComponentSenseResponse

    device reporting data of a register address in response to a ComponentActRequest

    restricted any
    uid: ComponentSenseResponse
    • #building_automation

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/button/{address}/{index}/push

    Any mesh node properly configured may pick up a button being pressed, resulting in this message being published. Notice, the system collapses button presses picked up by multiple mesh nodes for a short amount of time. Also be aware that button presses may be lost in cases where the mesh fails picking up the advertisement message, transmission gets lost over the air or due to messaging overloads. Such failures are expected to be rare but do exist. Since delivery can not be guaranteed this mechanism is unsuited for emergency or panic buttons.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies Beacon Device picking up the button press

    address
    required
    string
    uid: address

    physical BLE address of button pressed, 6-bytes coded as all lower-case hex digits

    index
    required
    string
    uid: index

    of hardware button segment allowing differentiating the segment pressed in case the button device has got multiple keys

    Accepts the following message:

    ButtonPushEvent

    device reporting the pickup of a button press

    restricted any
    uid: ButtonPushEvent
    • #building_automation

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{estimatorUuid}/calib/{runUuid}/measurement

    During indoor position estimation calibration the MeshGateway device reports raw measurement data to the BlueRange server. This message is internal and subject to change without notice. It is not meant to be used by 3rd party software acting as a middleware!

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    estimatorUuid
    required
    string
    uid: estimatorUuid

    identifies MeshGateway Device reporting the CalibrationMeasurement

    runUuid
    required
    string
    uid: runUuid

    identifies CalibrationRun executing

    Accepts the following message:

    CalibrationMeasurement

    Calibration measurement information

    restricted any
    uid: CalibrationMeasurement
    • #asset_tracking
    • #internal

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{estimatorUuid}/calib/{runUuid}/reference

    During indoor position estimation calibration the MeshGateway device reports raw measurement data to the BlueRange server. This message is internal and subject to change without notice. It is not meant to be used by 3rd party software acting as a middleware!

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    estimatorUuid
    required
    string
    uid: estimatorUuid

    identifies MeshGateway Device reporting the CalibrationReference

    runUuid
    required
    string
    uid: runUuid

    identifies CalibrationRun executing

    Accepts the following message:

    CalibrationReference

    Calibration measurement information

    restricted any
    uid: CalibrationReference
    • #asset_tracking
    • #internal

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{estimatorUuid}/indoor/{assetUuid}/deviceEstimate

    During indoor position tracking the MeshGateway reports device estimations. This message is internal and subject to change without notice. It is not meant to be used by 3rd party software acting as a middleware!

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    estimatorUuid
    required
    string
    uid: estimatorUuid

    identifies MeshGateway Device reporting the DeviceEstimate

    assetUuid
    required
    string
    uid: assetUuid

    identifies Asset tracked

    Accepts the following message:

    DeviceEstimate

    Device estimation information

    restricted any
    uid: DeviceEstimate
    • #asset_tracking
    • #internal

    Examples

  • SUB rltn-mdm/{organizationUuid}/{deviceUuid}/notifications/pendingActions

    This message is published by the BlueRange server to inform MeshGateway devices about outstanding MDM actions targetting devices of the mesh network. The body payload contains a total number of outstanding actions only. Upon reception the MeshGateway reads and processes the actual actions by contacting the BlueRange server it is enrolled at using the REST interface.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization of the MeshGateway

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies MeshGateway Device subject within Organization

    Accepts the following message:

    ActionWrapper

    Pending actions notification message

    restricted any
    uid: ActionWrapper
    • #internal

    Examples

  • SUB rltn-mdm/{organizationUuid}/{deviceUuid}/notifications/assetActions

    This message is published by the BlueRange server to inform MeshGateway devices about outstanding MDM actions targetting asset devices in range. The body payload contains a list of assets having outstanding actions. Upon reception the MeshGateway reads and processes the actual actions by contacting the BlueRange server it is enrolled at using the REST interface.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization of the MeshGateway

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies MeshGateway Device subject within Organization

    Accepts the following message:

    StringWrapper

    Asset actions notification message

    restricted any
    uid: StringWrapper
    • #internal

    Examples

  • SUB rltn-mdm/{organizationUuid}/{deviceUuid}/diag/{clientId}/error/{errorType}

    This message may be published by any participant to informat about an error condition.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization of the Device

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies Device subject within Organization, empty string for addressing the BlueRange server(s)

    clientId
    required
    string
    uid: clientId

    allows filtering by clientId, empty string matches all parties

    errorType
    required
    string
    uid: errorType

    an unspecified type discriminator allowing subscription for some particular kind of error

    Accepts the following message:

    MqttError

    Diagnostic error message

    restricted any
    uid: MqttError
    • #internal

    Examples

  • PUB rltn-mdm/{organizationUuid}/{deviceUuid}/diag/{clientId}/ping

    Requests a diagnostic pong reply. The message payload may be an arbitrary JSON object. Upon reception of matching topic variable(s), the incoming message payload is replayed using the pong topic. This internal message is subject of change without notice.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization of the Device

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies Device subject within Organization, empty string for addressing the BlueRange server(s)

    clientId
    required
    string
    uid: clientId

    allows filtering by clientId, empty string matches all parties

    Accepts the following message:

    JsonNode
    Payload
    restricted any
    uid: JsonNode
    • #asset_detection

    Examples

  • SUB rltn-mdm/{organizationUuid}/{deviceUuid}/diag/{clientId}/pong

    Responds a diagnostic ping request by replaying the message payload received. This internal message is subject of change without notice.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization of the Device

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies Device subject within Organization, the BlueRange server(s) use empty string value here

    clientId
    required
    string
    uid: clientId

    clientId of the responding party

    Accepts the following message:

    JsonNode
    Payload
    restricted any
    uid: JsonNode
    • #asset_detection

    Examples

  • PUB rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/assets///infoRequest

    Requests a mesh node to transmit what assets were detected nearby recently in the form of an infoResponse

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    deviceUuid
    required
    string
    uid: deviceUuid

    adresses a particular mesh node to report detected assets of

    Accepts the following message:

    AssetInfoRequest

    request current assets on mesh node

    Payload
    restricted any
    uid: AssetInfoRequest
    • #asset_detection

    Examples

  • SUB rltn-iot/{organizationUuid}/{siteUuid}/{deviceUuid}/assets///infoResponse

    Sent by a mesh node to report assets detected nearby in response to an infoRequest

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    siteUuid
    required
    string
    uid: siteUuid

    identifies Site subject within Organization

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies the mesh node reporting the assets detected nearby

    Accepts the following message:

    AssetInfoResponse

    response current assets from mesh node

    restricted any
    uid: AssetDetectionInfoResponse
    • #asset_detection

    Examples

  • SUB rltn-mqtt/{organizationUuid}/device/{deviceUuid}/statusChanged

    Fired by the MDM when the status of a device changes.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies Device subject

    Accepts the following message:

    DeviceStatusChangedEvent

    event informing about changes in the status of a device.

    restricted any
    uid: DeviceStatusChangedEvent
    • #device_management

    Examples

  • SUB rltn-mdm/{organizationUuid}/{deviceUuid}/statistics/{metricType}/networkMetric

    Send network statistics collected on a device

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies Device subject

    metricType
    required
    string
    uid: metricType

    identifies MetricType subject

    Accepts the following message:

    NetworkMetric

    Metric about the network activity to build up statistics

    restricted any
    uid: NetworkMetric
    • #device_management

    Examples

  • PUB rltn-mdm/{organizationUuid}/{deviceUuid}/health/{healthComponent}/healthRequest

    Request health data for all matching devices and health components. Empty string matches all.

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    deviceUuid
    required
    string
    uid: deviceUuid

    optionally identifies a single Device

    healthComponent
    required
    string
    uid: healthComponent

    optionally identifies a single HealthData by its component name

    Accepts the following message:

    HealthRequest

    Request the health status of a device

    restricted any
    uid: HealthRequest
    • #device_management

    Examples

  • SUB rltn-mdm/{organizationUuid}/{deviceUuid}/health/{healthComponent}/healthData

    Send a health component of a device

    organizationUuid
    required
    string
    uid: organizationUuid

    identifies Organization subject

    deviceUuid
    required
    string
    uid: deviceUuid

    identifies Device subject

    healthComponent
    required
    string
    uid: healthComponent

    identifies the HealthData by its component name

    Accepts the following message:

    HealthData

    The health status of a health component

    restricted any
    uid: HealthData
    • #device_management

    Examples

Messages

  • #1PositionEstimate

    Estimated position information

    object
    uid: PositionEstimate
    • #asset_tracking
  • #2AssetTrackingStateEvent

    Current state of the asset tracking system

    restricted any
    uid: AssetTrackingStateEvent
    • #asset_tracking
  • #3GeofenceEvent

    Geofence tracking message

    restricted any
    uid: GeofenceEvent
    • #asset_tracking
  • #4AssetTracking

    Geofence tracking message

    restricted any
    uid: GeofenceEvent
    • #asset_tracking
  • #5BeaconReport

    Beacon report message

    restricted any
    uid: BeaconReport
    • #beacon_reporting
  • #6BeaconReportBatch

    Beacon report batch message

    restricted any
    uid: BeaconReportBatch
    • #beacon_reporting
  • #7ActuatorData

    controls an actuator supplying a setpoint value

    restricted any
    uid: ActuatorData
    • #building_automation
  • #8IndicatorData

    Indicator notification

    restricted any
    uid: IndicatorData
    • #building_automation
  • #9SensorData

    Sensor raw value change notification

    restricted any
    uid: SensorData
    • #building_automation
  • #10SensorDataRequest

    request current SensorData measurements

    restricted any
    uid: SensorDataRequest
    • #building_automation
  • #11IdentifyDeviceRequest

    request device identification

    restricted any
    uid: IdentifyDeviceRequest
    • #internal
  • #12EnvironmentProfiles

    Perform actions based on environment profile

    restricted any
    uid: EnvironmentProfileRequest
    • #environment_profiles
  • #13ComponentActRequest

    instructs device to read data from and/or write data into a register address

    restricted any
    uid: ComponentActRequest
    • #building_automation
  • #14ComponentSenseResponse

    device reporting data of a register address in response to a ComponentActRequest

    restricted any
    uid: ComponentSenseResponse
    • #building_automation
  • #15ButtonPushEvent

    device reporting the pickup of a button press

    restricted any
    uid: ButtonPushEvent
    • #building_automation
  • #16CalibrationMeasurement

    Calibration measurement information

    restricted any
    uid: CalibrationMeasurement
    • #asset_tracking
    • #internal
  • #17CalibrationReference

    Calibration measurement information

    restricted any
    uid: CalibrationReference
    • #asset_tracking
    • #internal
  • #18DeviceEstimate

    Device estimation information

    restricted any
    uid: DeviceEstimate
    • #asset_tracking
    • #internal
  • #19ActionWrapper

    Pending actions notification message

    restricted any
    uid: ActionWrapper
    • #internal
  • #20StringWrapper

    Asset actions notification message

    restricted any
    uid: StringWrapper
    • #internal
  • #21MqttError

    Diagnostic error message

    restricted any
    uid: MqttError
    • #internal
  • #22JsonNode
    Payload
    restricted any
    uid: JsonNode
    • #asset_detection
  • #23AssetInfoResponse

    response current assets from mesh node

    restricted any
    uid: AssetDetectionInfoResponse
    • #asset_detection
  • #24AssetInfoRequest

    request current assets on mesh node

    Payload
    restricted any
    uid: AssetInfoRequest
    • #asset_detection
  • #25DeviceStatusChangedEvent

    event informing about changes in the status of a device.

    restricted any
    uid: DeviceStatusChangedEvent
    • #device_management
  • #26NetworkMetric

    Metric about the network activity to build up statistics

    restricted any
    uid: NetworkMetric
    • #device_management
  • #27HealthRequest

    Request the health status of a device

    restricted any
    uid: HealthRequest
    • #device_management
  • #28HealthData

    The health status of a health component

    restricted any
    uid: HealthData
    • #device_management

Schemas

  • object
    uid: PositionEstimate
  • restricted any
    uid: AssetTrackingStateEvent
  • restricted any
    uid: GeofenceEvent
  • restricted any
    uid: BeaconReport
  • restricted any
    uid: BeaconReportBatch
  • restricted any
    uid: ActuatorData
  • restricted any
    uid: IndicatorData
  • restricted any
    uid: SensorData
  • restricted any
    uid: SensorDataRequest
  • restricted any
    uid: IdentifyDeviceRequest
  • restricted any
    uid: EnvironmentProfileRequest
  • restricted any
    uid: ComponentActRequest
  • restricted any
    uid: ComponentSenseResponse
  • restricted any
    uid: ButtonPushEvent
  • restricted any
    uid: CalibrationMeasurement
  • restricted any
    uid: CalibrationReference
  • restricted any
    uid: DeviceEstimate
  • restricted any
    uid: ActionWrapper
  • restricted any
    uid: StringWrapper
  • restricted any
    uid: MqttError
  • JsonNode
    restricted any
    uid: JsonNode
  • AssetInfoRequest
    restricted any
    uid: AssetInfoRequest
  • restricted any
    uid: AssetDetectionInfoResponse
  • object
    uid: AssetDetectionInfo
  • restricted any
    uid: DeviceStatusChangedEvent
  • restricted any
    uid: NetworkMetric
  • restricted any
    uid: HealthRequest
  • restricted any
    uid: HealthData