This page provides an overview of MQTT topics that serve as digital twins for physical devices. These topics mirror the state and behavior of real-world devices, allowing for real-time monitoring, simulation, and control.
By subscribing to these topics, you can access virtual representations of device data, enabling advanced analytics, predictive maintenance, and optimized performance within DRIVR.
In order to facilitate this you can retrieve information about Organization, RoleAssignment, Role, Event, Setpoint, System, Component, … .
PLEASE NOTE: For comprehensive explanations of terms such as Domain, System, Component, Event, Service, Characteristic, and others used in this document, please refer to Terms.
DRIVR MQTT Broker
Subscribe for updates on the Domain with a specific slug. DRIVR supports multiple tenants in one instance, they are called domains. A slug is a unique identifier for your domain. For example, if slug is my_company then the domain URLs will be https://my_company.api.drivr.cloud/ (API doc) and https://my_company.ui.drivr.cloud/ (DRIVR UI). The Domain information is retained until the domain is deleted.
Available only on servers:
Accepts the following message:
General information about a Domain in DRIVR. Information is retained until the Domain is deleted.
{
"uuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
"slug": "adam",
"name": "Adam's DRIVR domain",
"status": "ACTIVATED",
"hostNames": [
"https://api.adam.drivr.cloud"
],
"ownerUuid": "52319891-c130-43bd-93ff-bad42f464c84",
"domainFeatures": [
{
"slug": "DELETE_ARCHIVE_ORGANIZATION_USERS",
"enabled": true
}
],
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of a Domain based on the given slug. A state of the domain can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the domain's state is DELETED, the domain is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the Domain. If the state is set to DELETED the Domain MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the ComponentModel within a given Domain using the componentModelUuid. A prototype of a Component, defining a device type and its capabilities.
Available only on servers:
Accepts the following message:
The current information which is stored for the ComponentModel within DRIVR. Information is retained until the ComponentModel is deleted.
{
"uuid": "973c576b-3158-4e51-8374-5fea435b9b68",
"code": "my-component-model",
"isConnective": true,
"description": "My awesome component model",
"componentType": "DEVICE",
"name": "my-component-model",
"domainUuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
"metadata": {
"property1": "string",
"property2": "string"
},
"status": "ACTIVATED",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the ComponentModel using the componentModelUuid. The state of the ComponentModel can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the ComponentModel's state is DELETED, the ComponentModel is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the ComponentModel. If the state is set to DELETED the ComponentModel MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the EventModel within a given Domain using the eventModelUuid. An EventModel is a prototype defining the structure of a specific type of `Event``.
Available only on servers:
Accepts the following message:
The current information which is stored for the EventModel within DRIVR. Information is retained until the EventModel is deleted.
{
"uuid": "973c576b-3158-4e51-8374-5fea435b9b68",
"code": "FIRE-ALARM",
"eventLevel": "ERROR",
"eventType": "SINGLE_POINT",
"entityType": "COMPONENT",
"limitToPrototypes": true,
"message": "Fire alarm triggered",
"domainUuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
"metadata": {
"property1": "string",
"property2": "string"
},
"status": "ACTIVATED",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the EventModel using the eventModelUuid. The state of the EventModel can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the EventModel's state is DELETED, the EventModel is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the EventModel. If the state is set to DELETED the EventModel MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the Organization within a given Domain using the organizationUuid. An Organization is a group of users within a domain. organizationUuid is a unique ID for an organization.
Available only on servers:
Accepts the following message:
The current information which is stored for the Organization within DRIVR. Information is retained until the Organization is deleted.
{
"uuid": "d837b268-0855-49ab-b6b2-1070ac7c838e",
"name": "Acme Ltd",
"alias": "6898400c-651d-4b36-8cd5-d1d8a152f68a",
"domainUuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
"ownerUuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
"metadata": {
"property1": "string",
"property2": "string"
},
"status": "ACTIVATED",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the Organization using the organizationUuid. The state of the organization can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the organization's state is DELETED, the organization is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the Organization. If the state is set to DELETED the Organization MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the global role assignments which are valid for the given domain using the roleAssignmentUuid. A RoleAssignment is a mapping between a Role (ie. Admin, Owner, Analyst etc), Entity (i.e System, Application Consumer etc) and an Account (i.e User, OrganizationUnit, or Organization). roleAssignmentUuid is a unique ID for a role assignment.
Available only on servers:
Accepts the following message:
A RoleAssignment which belongs to the Domain. Information is retained until the RoleAssignment is deleted.
An assignment which is published for a specific Role in DRIVR.
{
"uuid": "1c97e5d3-299e-4e57-83ae-473b43894f9e",
"assignee": {
"uuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
"type": "USER"
},
"role": {
"uuid": "958a8603-6d24-4e95-bcb4-e27a654f92f0",
"name": "Administrator"
},
"status": "ACTIVATED",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of global assignments for the given domain. The state of the role assignment can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the role assignment's state is DELETED, the role assignment is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the RoleAssignment. If the state is set to DELETED the RoleAssignment MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the RoleAssignment using the roleAssignmentUuid assigned to the provided applicationConsumer within a given domain. The applicationConsumer is identified by its applicationConsumerUuid. An applicationConsumer represents an application that uses DRIVR to authenticate users against the API. The applicationConsumerUuid is a unique identifier for an applicationConsumer and roleAssignmentUuid is a unique identifier for a roleAssignment.
Available only on servers:
Accepts the following message:
A RoleAssignment which belongs to the Domain. Information is retained until the RoleAssignment is deleted.
An assignment which is published for a specific Role in DRIVR.
{
"uuid": "1c97e5d3-299e-4e57-83ae-473b43894f9e",
"assignee": {
"uuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
"type": "USER"
},
"role": {
"uuid": "958a8603-6d24-4e95-bcb4-e27a654f92f0",
"name": "Administrator"
},
"status": "ACTIVATED",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the referenced RoleAssignment using the roleAssignmentUuid assigned to the provided applicationConsumer using the applicationConsumerUuid. The state of the role assignment for a specific applicationConsumer can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the role assignment's state is DELETED, the role assignment is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the RoleAssignment. If the state is set to DELETED the RoleAssignment MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the RoleAssignment using the roleAssignmentUuid assigned to the provided System using systemUuid within a given domain. A System serves as a logical group of one or more IoT components which are usually positioned at the same geographic location and serve a common system function in DRIVR. The systemUuid is a unique identifier for a system.
Available only on servers:
Accepts the following message:
A RoleAssignment which assigns roles to the System. Information is retained until the RoleAssignment is deleted.
An assignment which is published for a specific Role in DRIVR.
{
"uuid": "1c97e5d3-299e-4e57-83ae-473b43894f9e",
"assignee": {
"uuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
"type": "USER"
},
"role": {
"uuid": "958a8603-6d24-4e95-bcb4-e27a654f92f0",
"name": "Administrator"
},
"status": "ACTIVATED",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the referenced RoleAssignment which is assigned to the provided System. The state of the role assignment for a specific System can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the role assignment's state is DELETED, the role assignment is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the RoleAssignment. If the state is set to DELETED the RoleAssignment MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the RoleAssignment using the roleAssignmentUuid assigned to the provided Organization using the organizationUuid within a given domain. An Organization is a group of users which are managed together within a domain. The organizationUuid is a unique identifier for an organization.
Available only on servers:
Accepts the following message:
A RoleAssignment which belongs to the Domain. Information is retained until the RoleAssignment is deleted.
An assignment which is published for a specific Role in DRIVR.
{
"uuid": "1c97e5d3-299e-4e57-83ae-473b43894f9e",
"assignee": {
"uuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
"type": "USER"
},
"role": {
"uuid": "958a8603-6d24-4e95-bcb4-e27a654f92f0",
"name": "Administrator"
},
"status": "ACTIVATED",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the referenced RoleAssignment using the roleAssignmentUuid assigned to the provided Organization using the organizationUuid within a given domain. The state of the role assignment for a specific Organization can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED.
Available only on servers:
Accepts the following message:
The current state of the RoleAssignment. If the state is set to DELETED the RoleAssignment MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the configured Role using the roleUuid within a given domain. A Role is a set of permissions that can be assigned to a user, machineUser, organization, or organizationUnit. The roleUuid is a unique ID for a role. For more information, see Role Permissions.
Available only on servers:
Accepts the following message:
Information describing one Role within DRIVR. Information is retained until the Role is deleted.
{
"uuid": "958a8603-6d24-4e95-bcb4-e27a654f92f0",
"name": "Administrator",
"entityType": "DOMAIN",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the Role using the roleUuid within a given domain. The state of the role can be ACTIVATED, DEACTIVATED, ARCHIVED.
Available only on servers:
Accepts the following message:
The current state of the Role. If the state is set to DELETED the Role MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the System using its systemUuid within a given domain. A System serves as a logical group of one or more IoT components which are usually positioned at the same geographic location and serve a common system function in DRIVR. A systemUuid is a unique identifier for a system.
Available only on servers:
Accepts the following message:
Information about a System within a DRIVR Domain. Information is retained until the System is deleted.
{
"uuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
"code": "my-awesome-machine-device-conglomarate.example.com",
"name": "World domination device",
"description": "This system will make me rich.",
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2021-11-02T17:11:46.833029+00:00",
"status": "ACTIVATED",
"metadata": {
"property1": "string",
"property2": "string"
},
"domainUuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
"ownerUuid": "52319891-c130-43bd-93ff-bad42f464c84",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the System using the systemUuid within a given domain. The state of the system can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the system's state is DELETED, the system is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the System. If the state is set to DELETED the System MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the current connection state of the System using the systemUuid within a given domain. A connection state of the system can be CONNECTED, DISCONNECTED, PARTIALLY_CONNECTED, UNDEFINED. This information is retained until the system is deleted.
Available only on servers:
Accepts the following message:
The current connection status of the referenced System. Information is retained until the System is deleted.
Indicates the current connectivity of a System.
CONNECTED means that the System has at least one ACTIVATED and CONNECTED Component but no ACTIVATED and DISCONNECTED Component.
DISCONNECTED means that the System has no ACTIVATED and CONNECTED Component but at least one ACTIVATED and DISCONNECTED Component.
PARTIALLY_CONNECTED means that the System has at least one ACTIVATED and CONNECTED Component and at least one ACTIVATED and DISCONNECTED Component.
UNDEFINED means that the Components of the System are either all DEACTIVATED or ARCHIVED. The Components do report a connection state of UNDEFINED or NOT_CONNECTIVE. The System status is ARCHIVED or DEACTIVATED.
CONNECTED
DISCONNECTED
PARTIALLY_CONNECTED
UNDEFINED
Subscribe for updates on an Event using it's eventUuid assigned directly to the provided System using the systemUuid within a given domain. An Event is a message which is published by a System to indicate a change in state or a specific occurrence. Retains any currently ACTIVE RANGED events.
Available only on servers:
Accepts the following message:
General information about an Event in DRIVR. Information is retained while Event has an ACTIVE state.
{
"uuid": "90525c81-88f7-4fd9-8e10-54ee353cad7d",
"time": "2021-08-06T13:13:06.136333+00:00",
"endTime": "2021-08-07T13:13:06.136333+00:00",
"entityUuid": "98a41658-f66f-460b-bc0a-4e01ab5407e5",
"acknowledged": true,
"status": "ACTIVE",
"metadata": {
"property1": "string",
"property2": "string"
},
"eventModel": {
"uuid": "cb5889ad-71df-4c47-b9dc-27f2e1d796dd",
"eventType": "RANGED",
"eventLevel": "ERROR",
"code": "5343723",
"message": "A rebel ship has penetrated the exhaust port, evacuate immediately.",
"entityType": "COMPONENT"
},
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the Event using the eventUuid assigned to the System using the systemUuid within a given domain. A state of the event can be ACTIVE, RESOLVED. Only emitted for RANGED events. Retained if the status is ACTIVE.
Available only on servers:
Accepts the following message:
The current state of the Event. Retained if ACTIVE
ACTIVE
RESOLVED
Subscribe for updates on the acknowledgements of an Event for a system within a given domain. The System is identified by it's systemUuid and the associated Event for the acknowledgement by the eventUuid. An acknowledge is a message published by a user to indicate that they have seen the Event. Since an Event can be acknowledged by multiple people, this topic provides information if multiple users acknowledge the event.
Available only on servers:
Accepts the following message:
A message describing a User to acknowledge an Event. Information is not retained.
{
"time": "2021-08-06T14:39:44.368252+00:00",
"userUuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9"
}
Subscribe for updates on the Component using the componentCode within the System and the systemUuid within a given domain. A Component is an entity belonging to a System that represents an actual device that sends and receives data. Examples of components are devices, gateways, modules, parts or virtual devices. A componentCode is a unique identifier for a component within a system.
Available only on servers:
Accepts the following message:
General information about a Component within a DRIVR System.
{
"uuid": "993d991e-5ac6-4f1e-be43-be82346f3f88",
"code": "death-star-laser",
"name": "The death star laser",
"metadata": {
"property1": "string",
"property2": "string"
},
"componentModel": {
"uuid": "64665d2f-caf9-4976-8c0c-8a4493f5c951",
"code": "death-star-laser-plan",
"isConnective": true
},
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2021-11-02T17:11:46.833029+00:00",
"systemUuid": "e9423b70-9ded-4c85-8593-111ac872603e",
"status": "ACTIVATED",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the referenced Component using componentCode with the System using systemUuid within a domain. A state of the component can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the component's state is DELETED, the component is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the Component. If the state is set to DELETED the Component MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe for updates on the current connection state of the Component using componentCode within a System using systemUuid within a domain. A connection state of the component can be CONNECTED, DISCONNECTED, PARTIALLY_CONNECTED, UNDEFINED. This information is retained until the component is deleted.
Available only on servers:
Accepts the following message:
The current connection status of the referenced Component.
Describes the connection state of a Component.
CONNECTED means the Component has an active connection to DRIVR.
DISCONNECTED means the Component has been disconnected from DRIVR.
NOT_CONNECTIVE means the Component does not report the connection state and the Component's ComponentModel's isConnective is set to false.
UNDEFINED means the Component is connective but has never reported a connection state.
CONNECTED
DISCONNECTED
NOT_CONNECTIVE
UNDEFINED
Subscribe for updates on the Event using eventUuid assigned to the referenced Component using componentCode in a System using systemUuid within a domain. Retains any currently ACTIVE RANGED events.
Available only on servers:
Accepts the following message:
General information about an Event in DRIVR. Information is retained while Event has an ACTIVE state.
{
"uuid": "90525c81-88f7-4fd9-8e10-54ee353cad7d",
"time": "2021-08-06T13:13:06.136333+00:00",
"endTime": "2021-08-07T13:13:06.136333+00:00",
"entityUuid": "98a41658-f66f-460b-bc0a-4e01ab5407e5",
"acknowledged": true,
"status": "ACTIVE",
"metadata": {
"property1": "string",
"property2": "string"
},
"eventModel": {
"uuid": "cb5889ad-71df-4c47-b9dc-27f2e1d796dd",
"eventType": "RANGED",
"eventLevel": "ERROR",
"code": "5343723",
"message": "A rebel ship has penetrated the exhaust port, evacuate immediately.",
"entityType": "COMPONENT"
},
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on the current state of the Event using eventUuid within Component using componentCode of a System using systemUuid within a domain. A state of the event can be ACTIVE, RESOLVED. Only emitted for RANGED events. Retained if the status is ACTIVE.
Available only on servers:
Accepts the following message:
The current state of the Event. Retained if ACTIVE
ACTIVE
RESOLVED
Subscribe for updates on the Event using eventUuid is acknowledged for a reference Component using componentCode in a System within a domain. An ack i.e acknowledgement is a message which is published by a user to indicate that they have seen the Event. As an Event can be acknowledged by multiple people this topic has more information if multiple users acknowledge the event. This information is not retained.
Available only on servers:
Accepts the following message:
A message describing a User to acknowledge an Event. Information is not retained.
{
"time": "2021-08-06T14:39:44.368252+00:00",
"userUuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9"
}
Subscribe for updates on the current value of the referenced characteristic(characteristicUuid) of the service(serviceCode) of the component(componentCode) in the system(systemUuid) within the given domain. A Service groups multiple characteristics and defines a specific function of a device. The dp i.e Datapoint is the measurement data sent from the device to DRIVR. For example, a Component like smart socket has a Service like State Monitoring may include multiple characteristics like State , Current timestamp and the values for those characteristics like “ON” at 12:00 PM yesterday will be datapoints. The data payload is expected to be in the JSON format.
Available only on servers:
Accepts the following message:
A Datapoint which is published for a specific Characteristic within a Component.
The message structure which DRIVR sends if a Datapoint has been sent from a System.
{
"timeStreamUuid": "1e75b89a-810d-4d28-83f8-fffacae4cfad",
"time": "2019-08-24T14:15:22Z",
"value": null
}
Subscribe for updates on the current value of the referenced characteristic(characteristicUuid) of the service(serviceCode) of the component(componentCode) in the system(systemUuid) within the given domain. The dp i.e Datapoint is the measurement data sent from the device to DRIVR. For example, a Component like smart socket has a Service like State Monitoring may include multiple characteristics like State , Current timestamp and the values for those characteristics like “ON” at 12:00 PM yesterday will be datapoints. A msgpack is a binary format which is smaller and faster than JSON. The data payload is expected to be in the msgpack format.
Available only on servers:
Accepts the following message:
A Datapoint which is published for a specific Characteristic within a Component.
The message structure which DRIVR sends if a Datapoint has been sent from a System.
{
"timeStreamUuid": "1e75b89a-810d-4d28-83f8-fffacae4cfad",
"time": "2019-08-24T14:15:22Z",
"value": null
}
Subscribe for updates on the current request to change a setting of the referenced characteristic(characteristicCode) of the service(serviceCode) of the component(componentCode) within a system(systemUuid) in a given domain. A sp (i.e Setpoint) is a value set by a user or an application to change the state of a device. A receiptId is a unique identifier for a setpoint.
For example, a Component like Temperature Sensor has a Service like Temperature Monitoring may include multiple characteristics like Temperature, Current timestamp and the value set are Set "20 Degrees" at 12:00 PM Today will be Setpoint. The data payload is expected to be in the JSON format.
Available only on servers:
Accepts the following message:
A Setpoint for a specific Characteristic within a Service and Component.
The message structure which DRIVR sends if a Setpoint has been sent from a System.
{
"timeStreamUuid": "1e75b89a-810d-4d28-83f8-fffacae4cfad",
"value": null,
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}
Subscribe for updates on the current request to change a setting of the referenced characteristic(characteristicCode) of the service(serviceCode) of the component(componentCode) within a system(systemUuid) in a given domain. A sp (i.e Setpoint) is a value set by a user or an application to change the state of a device. For example, a Component like Temperature Sensor has a Service like Temperature Monitoring may include multiple characteristics like Temperature, Timestamp and the value set are Set "20 Degrees" at 12:00 PM Today will be Setpoint. The data payload is expected to be in the msgpack format. Emits payloads encoded as msgpack.
Available only on servers:
Accepts the following message:
A Setpoint for a specific Characteristic within a Service and Component.
The message structure which DRIVR sends if a Setpoint has been sent from a System.
{
"timeStreamUuid": "1e75b89a-810d-4d28-83f8-fffacae4cfad",
"value": null,
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}
Subscribe for updates on the current state of a Setpoint change, for a characteristic(characteristicCode) within a service(serviceCode) for a component(componentCode) within a system(systemUuid) in a given domain. A receiptId is a unique identifier for a setpoint. A state of the setpoint can be CREATED, REJECTED, ACCEPTED.
Available only on servers:
Accepts the following message:
A state change of a Setpoint for a specific Characteristic within a Service and Component.
The payload of a Setpoint state change.
{
"state": "CREATED",
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}
Subscribe for updates on the current state of a Setpoint change for a characteristic(characteristicCode) within a service(serviceCode) for a component(componentCode) within a system(systemUuid) within a given domain. A receiptId is a unique identifier for a setpoint. A state of the setpoint can be CREATED, REJECTED, ACCEPTED. Emits the payload encoded as msgpack.
Available only on servers:
Accepts the following message:
A state change of a Setpoint for a specific Characteristic within a Service and Component.
The payload of a Setpoint state change.
{
"state": "CREATED",
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}
Subscribe for updates on when a message has been published during a Setpoint(receiptId) change for a characteristic(characteristicCode) within a service(serviceCode) for a component(componentCode) within a system(systemUuid) within a given domain. A message is a statement or information which is sent to indicate a change in state or a specific occurrence. The data payload is expected to be in the JSON format.
Available only on servers:
Accepts the following message:
A message for a Setpoint for a specific Characteristic within a Service and Component.
An optional message to add to the receipt of a Setpoint.
{
"message": "Unrestricted submarine warfare is not allowed by international law.",
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}
Subscribe for updates on when a message has been published during a Setpoint(receiptId) change for a characteristic(characteristicCode) within a service(serviceCode) for a component(componentCode) within a system(systemUuid) within a given domain. A message is a statement or information which is sent to indicate a change in state or a specific occurrence. Publishes the payload encoded as msgpack.
Available only on servers:
Accepts the following message:
A message for a Setpoint for a specific Characteristic within a Service and Component.
An optional message to add to the receipt of a Setpoint.
{
"message": "Unrestricted submarine warfare is not allowed by international law.",
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}
Subscribe for updates on a user using userUuid in the given domain. A user is a person who uses the DRIVR platform. userUuid is a unique ID for a user.
Available only on servers:
Accepts the following message:
The current information which is stored for the User within DRIVR. Information is retained until the User is deleted.
{
"uuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
"email": "user@drivr.cloud",
"name": "Dan Moore",
"alias": "danmoore@gmail.com",
"domainUuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
"organizationUuid": "d837b268-0855-49ab-b6b2-1070ac7c838e",
"metadata": {
"property1": "string",
"property2": "string"
},
"status": "ACTIVATED",
"createdAt": "2021-08-06T13:13:06.136333+00:00",
"updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
Subscribe for updates on a user's state within the given domain. The state of the user can be CREATED, ACTIVATED, DEACTIVATED, ARCHIVED, DELETED. Once the user's state is DELETED, the user is no longer accessible.
Available only on servers:
Accepts the following message:
The current state of the User. If the state is set to DELETED the User MQTT topics and all information within will be deleted.
The state of the object as presented within MQTT.
CREATED
ACTIVATED
DEACTIVATED
ARCHIVED
DELETED
Subscribe to Setpoints(i.e sp) for Systems(i.e s) using systemUuid. This topic sends additionally to the payload which should be changed the referenced codes of the Characteristic, Service and Component. The data payload is expected to be in the JSON format.
Available only on servers:
Accepts the following message:
The payload to be processed by DRIVR recording an intent by a User to change a SETTING Characteristic in DRIVR. Includes additionally to the basic Setpoint parameters the codes of the Characteristic, Service, and Component.
The message structure to send a new to be recorded Setpoint for a SETTING Characteristic on a System's Component. It includes the code of the Characteristic, Service, and Component to be recorded.
{
"componentCode": "engine",
"serviceCode": "screwdriver_motor",
"characteristicCode": "engine_speed",
"serviceIndex": 0,
"value": null,
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}
Subscribe to Setpoints(i.e sp) for Systems(i.e s) using systemUuid.
This topic sends additionally to the payload which should be changed the referenced codes of the Characteristic, Service and Component.
The data payload is expected to be in the msgpack format.
Available only on servers:
Accepts the following message:
The payload to be processed by DRIVR recording an intent by a User to change a SETTING Characteristic in DRIVR. Includes additionally to the basic Setpoint parameters the codes of the Characteristic, Service, and Component.
The message structure to send a new to be recorded Setpoint for a SETTING Characteristic on a System's Component. It includes the code of the Characteristic, Service, and Component to be recorded.
{
"componentCode": "engine",
"serviceCode": "screwdriver_motor",
"characteristicCode": "engine_speed",
"serviceIndex": 0,
"value": null,
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}
Subscribe to Setpoints(i.e sp) for Systems(i.e s) using systemUuid. This topic provides additionally to the payload which should be changed the referenced UUIDs of the Characteristic, Service and Component. The data payload is expected to be in the JSON format.
Available only on servers:
Accepts the following message:
The payload to be processed by DRIVR recording an intent by a User to change a SETTING Characteristic in DRIVR. Includes additionally to the basic Setpoint parameters the UUIDs of the Characteristic, Service, and Component.
The message structure to send a new to be recorded Setpoint for a SETTING Characteristic on a System's Component. It includes the UUID of the Characteristic, Service, and Component to be recorded.
{
"componentUuid": "cd529782-7d99-4dd4-99a6-d3c6cc5aef87",
"serviceUuid": "6ffa18c2-e27a-43c8-913c-e64e00de1238",
"characteristicUuid": "af4789d7-48b8-4a5a-9d6b-3969ef2584b5",
"serviceIndex": 0,
"value": null,
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}
Subscribe to Setpoints(i.e sp) for Systems(i.e s) using systemUuid. This topic also sends the referenced UUIDs of the Characteristic, Service, and Component along with the payload that should be changed. The data payload is expected to be in the msgpack format.
Available only on servers:
Accepts the following message:
The payload to be processed by DRIVR recording an intent by a User to change a SETTING Characteristic in DRIVR. Includes additionally to the basic Setpoint parameters the UUIDs of the Characteristic, Service, and Component.
The message structure to send a new to be recorded Setpoint for a SETTING Characteristic on a System's Component. It includes the UUID of the Characteristic, Service, and Component to be recorded.
{
"componentUuid": "cd529782-7d99-4dd4-99a6-d3c6cc5aef87",
"serviceUuid": "6ffa18c2-e27a-43c8-913c-e64e00de1238",
"characteristicUuid": "af4789d7-48b8-4a5a-9d6b-3969ef2584b5",
"serviceIndex": 0,
"value": null,
"time": "2019-08-24T14:15:22Z",
"receiptId": "fn2rn3"
}