The API projects the current state of all DRIVR domains in a DRIVR cluster onto MQTT.
DRIVR MQTT Broker
Returns information about the domain.
Available only on servers:
The slug of your individual Domain
.
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"
}
Returns the current status of a domain.
Available only on servers:
The slug of your individual Domain
.
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
Returns information about the Organization
in the DRIVR Domain
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the Organization
within DRIVR.
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"
}
Provides the current state of the Organization
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the Organization
within DRIVR.
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
Returns the global assignments which are valid for the complete Domain
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the RoleAssignment
within DRIVR.
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"
}
The current state global assignments which are valid for the complete Domain
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the RoleAssignment
within DRIVR.
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
Returns information about the RoleAssignment
which is assigned to the provided ApplicationConsumer
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the ApplicationConsumer
within DRIVR.
The unique UUID of the RoleAssignment
within DRIVR.
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"
}
Provides the current state of the referenced RoleAssignment
which is assigned to the provided ApplicationConsumer
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the ApplicationConsumer
within DRIVR.
The unique UUID of the RoleAssignment
within DRIVR.
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
Returns information about the RoleAssignment
which is assigned to the provided System
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
The unique UUID of the RoleAssignment
within DRIVR.
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"
}
Provides the current state of the referenced RoleAssignment
which is assigned to the provided System
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
The unique UUID of the RoleAssignment
within DRIVR.
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
Returns information about the RoleAssignment
which is assigned to the provided Organization
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the Organization
within DRIVR.
The unique UUID of the RoleAssignment
within DRIVR.
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"
}
Provides the current state of the referenced RoleAssignment
which is assigned to the provided Organization
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the Organization
within DRIVR.
The unique UUID of the RoleAssignment
within DRIVR.
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
Returns information about the configured Role
with the provided Role
UUID.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the Role
within DRIVR.
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"
}
Provides the current state of the Role
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the Role
within DRIVR.
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
Returns information about the System
with the provided UUID.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
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"
}
Provides the current state of the System
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
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
Provides the current connection state of the System
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
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
Lists all Events
s which are assigned directly to the provided System
and not to any Component
s on the System
. Retains any currently ACTIVE
RANGED
events.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
The unique UUID of the Event
within DRIVR.
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"
}
Publishes status changes of the Event
with the provided UUID. Only emitted for RANGED
events. Retained if the status is ACTIVE
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
The unique UUID of the Event
within DRIVR.
Accepts the following message:
The current state of the Event
. Retained if ACTIVE
ACTIVE
RESOLVED
Issued when the event is acknowledged. As an event can be acknowledged by multiple people this topic has more information if multiple User
acknowledge the event. However, compared to the generic Event
topic it is not retained.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
The unique UUID of the Event
within DRIVR.
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"
}
Returns information about the Component
in the System
as it is currently within DRIVR
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
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"
}
Returns the current state of the referenced Component
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
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
Provides the current connection state of the Component
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
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
Lists all Events
s which are assigned to the referenced Component
. Retains any currently ACTIVE
RANGED
events.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
The unique UUID of the Event
within DRIVR.
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"
}
Publishes status changes of the Event
with the provided UUID. Only emitted for RANGED
events. Retained if the status is ACTIVE
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
The unique UUID of the Event
within DRIVR.
Accepts the following message:
The current state of the Event
. Retained if ACTIVE
ACTIVE
RESOLVED
Issued when the event is acknowledged. As an event can be acknowledged by multiple people this topic has more information if multiple User
acknowledge the event. However, compared to the generic Event
topic it is not retained.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
The unique UUID of the Event
within DRIVR.
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"
}
Publishes the current value of the referenced Characteristic
of the Service
of the Component
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
A uniquely identifiable code of a Service
within a DRIVR Domain
.
The index of a Service
referenced when adding a Service
to a ComponentModel
in DRIVR
.
A uniquely identifiable code of a Characteristic
within a Service
.
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
}
Publishes the current value of the referenced Characteristic
of the Service
of the Component
. Emits payloads encoded as msgpack.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
A uniquely identifiable code of a Service
within a DRIVR Domain
.
The index of a Service
referenced when adding a Service
to a ComponentModel
in DRIVR
.
A uniquely identifiable code of a Characteristic
within a Service
.
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
}
Publishes the current request to change a Setting
of the referenced Characteristic
of the Service
of the Component
.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
A uniquely identifiable code of a Service
within a DRIVR Domain
.
The index of a Service
referenced when adding a Service
to a ComponentModel
in DRIVR
.
A uniquely identifiable code of a Characteristic
within a Service
.
The receipt ID of a Setpoint
within DRIVR used by a System
to report back once the Setting
change request on a TimeStream
has been done.
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"
}
Publishes the current request to change a Setting
of the referenced Characteristic
of the Service
of the Component
. Emits payloads encoded as msgpack.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
A uniquely identifiable code of a Service
within a DRIVR Domain
.
The index of a Service
referenced when adding a Service
to a ComponentModel
in DRIVR
.
A uniquely identifiable code of a Characteristic
within a Service
.
The receipt ID of a Setpoint
within DRIVR used by a System
to report back once the Setting
change request on a TimeStream
has been done.
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"
}
Publishes the current state of a Setpoint
change.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
A uniquely identifiable code of a Service
within a DRIVR Domain
.
The index of a Service
referenced when adding a Service
to a ComponentModel
in DRIVR
.
A uniquely identifiable code of a Characteristic
within a Service
.
The receipt ID of a Setpoint
within DRIVR used by a System
to report back once the Setting
change request on a TimeStream
has been done.
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"
}
Publishes the current state of a Setpoint
change. Publishes the payload encoded as msgpack.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
A uniquely identifiable code of a Service
within a DRIVR Domain
.
The index of a Service
referenced when adding a Service
to a ComponentModel
in DRIVR
.
A uniquely identifiable code of a Characteristic
within a Service
.
The receipt ID of a Setpoint
within DRIVR used by a System
to report back once the Setting
change request on a TimeStream
has been done.
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"
}
Published when a message has been published during a Setpoint
change.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
A uniquely identifiable code of a Service
within a DRIVR Domain
.
The index of a Service
referenced when adding a Service
to a ComponentModel
in DRIVR
.
A uniquely identifiable code of a Characteristic
within a Service
.
The receipt ID of a Setpoint
within DRIVR used by a System
to report back once the Setting
change request on a TimeStream
has been done.
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"
}
Published when a message has been published during a Setpoint
change. Publishes the payload encoded as msgpack.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
A uniquely identifiable code of an ACTIVATED
Component
within a DRIVR System
.
A uniquely identifiable code of a Service
within a DRIVR Domain
.
The index of a Service
referenced when adding a Service
to a ComponentModel
in DRIVR
.
A uniquely identifiable code of a Characteristic
within a Service
.
The receipt ID of a Setpoint
within DRIVR used by a System
to report back once the Setting
change request on a TimeStream
has been done.
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"
}
Receives information about a User
in the Domain.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the User
within DRIVR.
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"
}
Receives information about a User
's state in the Domain.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the User
within DRIVR.
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
Publish Events
by Connectors
. Only entities which are allowed to manipulate a complete Domain
can use this topic. This topic is intended for other Applications which are sending data from multiple Systems
. Compared to adding the issuerUuid
in the topic it can be added in the payload. If not set, issuerUuid
will not be recorded or set. If a uuid
is set in the payload, the event with it will be updated. The data payload is expected to be JSON.
Available only on servers:
The slug of your individual Domain
.
Accepts the following message:
The payload to be processed by DRIVR to import Events
on the global MQTT endpoints. Allows to additionally record an issuerUuid
in the payload and is intended for Connectors
, Systems
and mass data processing. The EventModel
can be specified via either its uuid
or code
. Existing Events
within DRIVR get updated if uuid
is set or the Event
can be identified via the exact time
and either the eventModelUuid
or eventModelCode
Sending a single `Event` with a set `issuerUuid` and a fixed time.
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Sending a single `Event` with a set `issuerUuid` and a fixed time using `eventModelCode` to identify the `EventModel`.
{
"eventModelCode": "fire-alarm",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Sending multiples `Events` with a set `issuerUuid` and a fixed time.
[
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelCode": "fire-alarm",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"time": "2021-08-06T13:14:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
]
This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the JSON format.
Available only on servers:
The slug of your individual Domain
.
Accepts the following message:
{
"property1": "string",
"property2": "string"
}
Publish Events
by Connectors
. Only entities which are allowed to manipulate a complete Domain
can use this topic. This topic is intended for other Applications which are sending data from multiple Systems
. Compared to adding the issuerUuid
in the topic it can be added in the payload. If not set, issuerUuid
will not be recorded or set. If a uuid
is set in the payload, the event with it will be updated. The data payload is expected to be in the msgpack format.
Available only on servers:
The slug of your individual Domain
.
Accepts the following message:
The payload to be processed by DRIVR to import Events
on the global MQTT endpoints. Allows to additionally record an issuerUuid
in the payload and is intended for Connectors
, Systems
and mass data processing. The EventModel
can be specified via either its uuid
or code
. Existing Events
within DRIVR get updated if uuid
is set or the Event
can be identified via the exact time
and either the eventModelUuid
or eventModelCode
Sending a single `Event` with a set `issuerUuid` and a fixed time.
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Sending a single `Event` with a set `issuerUuid` and a fixed time using `eventModelCode` to identify the `EventModel`.
{
"eventModelCode": "fire-alarm",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Sending multiples `Events` with a set `issuerUuid` and a fixed time.
[
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelCode": "fire-alarm",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"time": "2021-08-06T13:14:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
]
This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the msgpack format.
Available only on servers:
The slug of your individual Domain
.
Accepts the following message:
{
"property1": "string",
"property2": "string"
}
Publish Events
by Connectors
. Only entities which are allowed to manipulate a complete Domain
can use this topic. This topic is intended for other Applications which are sending data from multiple Systems
. Compared to adding the issuerUuid
in the topic it can be added in the payload. If not set, issuerUuid
will not be recorded or set. If a uuid
is set in the payload, the event with it will be updated. The data payload is expected to be JSON.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the User
or System
of the entity in DRIVR which issues the change.
Accepts the following message:
The payload to be processed by DRIVR to import Events
on the global MQTT endpoints.
Sending a single `Event` with a fixed time.
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00"
}
Sending a single `Event` with a fixed time using `eventModelCode` to identify the `EventModel`.
{
"eventModelCode": "fire-alarm",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"time": "2021-08-06T13:13:06.136333+00:00"
}
Sending multiples `Events` with a fixed time.
[
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00"
},
{
"eventModelCode": "fire-alarm",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"time": "2021-08-06T13:14:06.136333+00:00"
},
{
"eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00"
}
]
This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the JSON format.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the User
or System
of the entity in DRIVR which issues the change.
Accepts the following message:
{
"property1": "string",
"property2": "string"
}
Publish Events
by Connectors
. Only entities which are allowed to manipulate a complete Domain
can use this topic. This topic is intended for other Applications which are sending data from multiple Systems
. Compared to adding the issuerUuid
in the topic it can be added in the payload. If not set, issuerUuid
will not be recorded or set. If a uuid
is set in the payload, the event with it will be updated. The data payload is expected to be in the msgpack format.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the User
or System
of the entity in DRIVR which issues the change.
Accepts the following message:
The payload to be processed by DRIVR to import Events
on the global MQTT endpoints.
Sending a single `Event` with a fixed time.
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00"
}
Sending a single `Event` with a fixed time using `eventModelCode` to identify the `EventModel`.
{
"eventModelCode": "fire-alarm",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"time": "2021-08-06T13:13:06.136333+00:00"
}
Sending multiples `Events` with a fixed time.
[
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00"
},
{
"eventModelCode": "fire-alarm",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"time": "2021-08-06T13:14:06.136333+00:00"
},
{
"eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
"uuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00"
}
]
This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the msgpack format.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the User
or System
of the entity in DRIVR which issues the change.
Accepts the following message:
{
"property1": "string",
"property2": "string"
}
Publish Events
by Systems
. This topic can only be used by Systems
themselves. Compared to adding the issuerUuid
in the topic it can be added in the payload. If not set, systemUuid
will used as issuerUuid. If a uuid
is set in the payload, the event with it will be updated. The data payload is expected to be JSON.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
Accepts the following message:
The payload to be processed by DRIVR to import Events
on the system MQTT endpoints. Allows to additionally record an issuerUuid
in the payload and is intended for Connectors
, Systems
and mass data processing. The EventModel
can be specified via either its uuid
or code
. Existing Events
within DRIVR get updated if uuid
is set or the Event
can be identified via the exact time
and either the eventModelUuid
or eventModelCode
Sending a single `Event` with a set `issuerUuid` and a fixed time.
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Sending a single `Event` with a set `issuerUuid` and a fixed time using `eventModelCode` to identify the `EventModel`.
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Sending multiples `Events` with a set `issuerUuid` and a fixed time for a referenced component by `code` and one for a referenced component by `uuid`.
[
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4",
"componentCode": "battery"
},
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4",
"componentUuid": "25ae1d96-5fb5-4925-9bd9-b6b0bb8a82e8"
}
]
This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the JSON format.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
Accepts the following message:
{
"property1": "string",
"property2": "string"
}
Publish Events
by Systems
. This topic can only be used by Systems
themselves. If not set, systemUuid
will used as issuerUuid. If a uuid
is set in the payload, the event with it will be updated. The data payload is expected to be in the msgpack format.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
Accepts the following message:
The payload to be processed by DRIVR to import Events
on the system MQTT endpoints. Allows to additionally record an issuerUuid
in the payload and is intended for Connectors
, Systems
and mass data processing. The EventModel
can be specified via either its uuid
or code
. Existing Events
within DRIVR get updated if uuid
is set or the Event
can be identified via the exact time
and either the eventModelUuid
or eventModelCode
Sending a single `Event` with a set `issuerUuid` and a fixed time.
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Sending a single `Event` with a set `issuerUuid` and a fixed time using `eventModelCode` to identify the `EventModel`.
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Sending multiples `Events` with a set `issuerUuid` and a fixed time for a referenced component by `code` and one for a referenced component by `uuid`.
[
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4",
"componentCode": "battery"
},
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4",
"componentUuid": "25ae1d96-5fb5-4925-9bd9-b6b0bb8a82e8"
}
]
This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the msgpack format.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
Accepts the following message:
{
"property1": "string",
"property2": "string"
}
Publish Events
by Systems
. This topic can only be used by Systems
themselves. If not set, systemUuid
will used as issuerUuid. If a uuid
is set in the payload, the event with it will be updated. The data payload is expected to be JSON.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
The unique UUID of the User
or System
of the entity in DRIVR which issues the change.
Accepts the following message:
The payload to be processed by DRIVR to import Events
on the system MQTT endpoints.
Sending a single `Event` with a fixed time.
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00"
}
Sending a single `Event` with a fixed time using `eventModelCode` to identify the `EventModel`.
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:13:06.136333+00:00"
}
Sending multiples `Events` with a fixed time. One for the component with code `battery` and one for the component with code `solar-panel` as well as a system event.
[
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00"
},
{
"eventModelCode": "fire-alarm",
"componentCode": "solar-panel",
"uuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00"
},
{
"eventModelCode": "fire-alarm",
"componentCode": "battery",
"uuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00"
}
]
This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the JSON format.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
The unique UUID of the User
or System
of the entity in DRIVR which issues the change.
Accepts the following message:
{
"property1": "string",
"property2": "string"
}
Publish Events
for Systems
. This topic can only be used by Systems
themselves. If not set, systemUuid
will used as issuerUuid. If a uuid
is set in the payload, the event with it will be updated. The data payload is expected to be in the msgpack format.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
The unique UUID of the User
or System
of the entity in DRIVR which issues the change.
Accepts the following message:
The payload to be processed by DRIVR to import Events
on the system MQTT endpoints.
Sending a single `Event` with a fixed time.
{
"eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"uuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
"time": "2021-08-06T13:13:06.136333+00:00"
}
Sending a single `Event` with a fixed time using `eventModelCode` to identify the `EventModel`.
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:13:06.136333+00:00"
}
Sending multiples `Events` with a fixed time. One for the component with code `battery` and one for the component with code `solar-panel` as well as a system event.
[
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00"
},
{
"eventModelCode": "fire-alarm",
"componentCode": "solar-panel",
"uuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00"
},
{
"eventModelCode": "fire-alarm",
"componentCode": "battery",
"uuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
"time": "2021-08-06T13:13:06.136333+00:00"
}
]
This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the msgpack format.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the System
within DRIVR.
The unique UUID of the User
or System
of the entity in DRIVR which issues the change.
Accepts the following message:
{
"property1": "string",
"property2": "string"
}
Publish Events
by Components
. This topic can only be used by Components
themselves. Compared to adding the issuerUuid
in the topic it can be added in the payload. If not set, componentUuid
will used as issuerUuid. If a uuid
is set in the payload, the event with it will be updated. The data payload is expected to be JSON.
Available only on servers:
The slug of your individual Domain
.
The unique UUID of the Component
within DRIVR.
Accepts the following message:
The payload to be processed by DRIVR to import Events
on the component MQTT endpoints. Optionally, an issuerUuid
can be set to identify the issuer of the Event
.