This page provides an overview of all MQTT topics that can be used for on-device error/informational event management. This allows you to retrieve Event information and states as well as Create, Update, Acknowledge Events within DRIVR. Each input topic, or topic where you can publish a message, has a corresponding topic ending with /error. This can be used for debugging and error handling purposes as DRIVR will return error messages which might occur.
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 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:
The slug of your individual Domain.
The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).
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:
The slug of your individual Domain.
The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).
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 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:
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"
}
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:
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
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:
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"
}
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:
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"
}
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:
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
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:
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 events by systems. A s i.e 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. 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"
}
]
Subscribe to get the validation errors which occur during processing on the parent topic(drivr/v1/{slug}/input/event/s/{systemUuid}/json) based on the System(i.e s) using systemUuid. 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:
An error message from the server.
{
"code": "SOME_DATA_INVALID",
"message": "Some Events couldn't be imported/updated.",
"stats": {
"total": 3,
"errors": 2,
"imported": 1
},
"errors": {
"1": [
{
"code": "entity_does_not_exist",
"message": {
"entityUuid": [
"Not a valid UUID."
]
}
}
],
"2": [
{
"code": "event_model_does_not_exist",
"message": {
"eventModelUuid": [
"Not a valid UUID."
]
}
}
]
}
}
Publishes events by systems. A s i.e 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. 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"
}
]
Subscribe to get the validation errors which occur during processing on the parent topic(drivr/v1/{slug}/input/event/s/{systemUuid}/msgpack) based on the System(i.e s) using systemUuid. 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:
An error message from the server.
{
"code": "SOME_DATA_INVALID",
"message": "Some Events couldn't be imported/updated.",
"stats": {
"total": 3,
"errors": 2,
"imported": 1
},
"errors": {
"1": [
{
"code": "entity_does_not_exist",
"message": {
"entityUuid": [
"Not a valid UUID."
]
}
}
],
"2": [
{
"code": "event_model_does_not_exist",
"message": {
"eventModelUuid": [
"Not a valid UUID."
]
}
}
]
}
}
Publishes the events by systems. A s i.e 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. 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"
}
]
Subscribe to get the validation errors which occur during processing on the parent topic(drivr/v1/{slug}/input/event/s/{systemUuid}/json/{issuerUuid}) based on the System(i.e s) using systemUuid and issuerUuid. 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:
An error message from the server.
{
"code": "SOME_DATA_INVALID",
"message": "Some Events couldn't be imported/updated.",
"stats": {
"total": 3,
"errors": 2,
"imported": 1
},
"errors": {
"1": [
{
"code": "entity_does_not_exist",
"message": {
"entityUuid": [
"Not a valid UUID."
]
}
}
],
"2": [
{
"code": "event_model_does_not_exist",
"message": {
"eventModelUuid": [
"Not a valid UUID."
]
}
}
]
}
}
Publishes events for systems. A s i.e 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. 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"
}
]
Subscribe to get the validation errors which occur during processing on the parent topic(drivr/v1/{slug}/input/event/s/{systemUuid}/msgpack/{issuerUuid}) based on the System(i.e s) using systemUuid and issuerUuid. 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:
An error message from the server.
{
"code": "SOME_DATA_INVALID",
"message": "Some Events couldn't be imported/updated.",
"stats": {
"total": 3,
"errors": 2,
"imported": 1
},
"errors": {
"1": [
{
"code": "entity_does_not_exist",
"message": {
"entityUuid": [
"Not a valid UUID."
]
}
}
],
"2": [
{
"code": "event_model_does_not_exist",
"message": {
"eventModelUuid": [
"Not a valid UUID."
]
}
}
]
}
}
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.
Sending a single `Event` with a fixed time.
{
"eventModelUuid": "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 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 fixed times. One without an explicit issuer set.
[
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelCode": "fire-clearance",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelCode": "drill-checkup",
"time": "2021-08-06T13:13:06.136333+00:00"
}
]
Subscribe to get the validation errors which occur during processing on the parent topic(drivr/v1/{slug}/input/event/c/{componentUuid}/json) based on the Component(i.e c) using componentUuid. 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 Component within DRIVR.
Accepts the following message:
An error message from the server.
{
"code": "SOME_DATA_INVALID",
"message": "Some Events couldn't be imported/updated.",
"stats": {
"total": 3,
"errors": 2,
"imported": 1
},
"errors": {
"1": [
{
"code": "entity_does_not_exist",
"message": {
"entityUuid": [
"Not a valid UUID."
]
}
}
],
"2": [
{
"code": "event_model_does_not_exist",
"message": {
"eventModelUuid": [
"Not a valid UUID."
]
}
}
]
}
}
Publish Events by Components. This topic can only be used by Components themselves. 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 in the msgpack format.
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.
Sending a single `Event` with a fixed time.
{
"eventModelUuid": "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 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 fixed times. One without an explicit issuer set.
[
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelCode": "fire-clearance",
"time": "2021-08-06T13:13:06.136333+00:00",
"issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
},
{
"eventModelCode": "drill-checkup",
"time": "2021-08-06T13:13:06.136333+00:00"
}
]
Subscribe to get the errors which occur during processing on the parent topic(drivr/v1/{slug}/input/event/c/{componentUuid}/msgpack) based on the Component(i.e c) using componentUuid. 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 Component within DRIVR.
Accepts the following message:
An error message from the server.
{
"code": "SOME_DATA_INVALID",
"message": "Some Events couldn't be imported/updated.",
"stats": {
"total": 3,
"errors": 2,
"imported": 1
},
"errors": {
"1": [
{
"code": "entity_does_not_exist",
"message": {
"entityUuid": [
"Not a valid UUID."
]
}
}
],
"2": [
{
"code": "event_model_does_not_exist",
"message": {
"eventModelUuid": [
"Not a valid UUID."
]
}
}
]
}
}
Publish Events by Components. This topic can only be used by Components themselves. 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.
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 component MQTT endpoints.
Sending a single `Event` with a fixed time.
{
"eventModelUuid": "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 times.
[
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00"
},
{
"eventModelCode": "fire-clearance",
"time": "2021-08-06T13:13:06.136333+00:00"
},
{
"eventModelCode": "drill-checkup",
"time": "2021-08-06T13:13:06.136333+00:00"
}
]
Subscribe to get the errors which occur during processing on the parent topic(drivr/v1/{slug}/input/event/c/{componentUuid}/json/{issuerUuid}) based on the Component(i.e c) using componentUuid and issuerUuid. 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 Component within DRIVR.
The unique UUID of the User or System of the entity in DRIVR which issues the change.
Accepts the following message:
An error message from the server.
{
"code": "SOME_DATA_INVALID",
"message": "Some Events couldn't be imported/updated.",
"stats": {
"total": 3,
"errors": 2,
"imported": 1
},
"errors": {
"1": [
{
"code": "entity_does_not_exist",
"message": {
"entityUuid": [
"Not a valid UUID."
]
}
}
],
"2": [
{
"code": "event_model_does_not_exist",
"message": {
"eventModelUuid": [
"Not a valid UUID."
]
}
}
]
}
}
Publish Events for Components. This topic can only be used by Components themselves. 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 in the msgpack format.
Available only on servers:
The slug of your individual Domain.
The unique UUID of the Component 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 component MQTT endpoints.
Sending a single `Event` with a fixed time.
{
"eventModelUuid": "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 times.
[
{
"eventModelCode": "fire-alarm",
"time": "2021-08-06T13:14:06.136333+00:00"
},
{
"eventModelCode": "fire-clearance",
"time": "2021-08-06T13:13:06.136333+00:00"
},
{
"eventModelCode": "drill-checkup",
"time": "2021-08-06T13:13:06.136333+00:00"
}
]
Subscribe to get the errors which occur during processing on the parent topic(drivr/v1/{slug}/input/event/c/{componentUuid}/msgpack/{issuerUuid}) based on the Component(i.e c) using componentUuid and issuerUuid. 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 Component within DRIVR.
The unique UUID of the User or System of the entity in DRIVR which issues the change.
Accepts the following message:
An error message from the server.
{
"code": "SOME_DATA_INVALID",
"message": "Some Events couldn't be imported/updated.",
"stats": {
"total": 3,
"errors": 2,
"imported": 1
},
"errors": {
"1": [
{
"code": "entity_does_not_exist",
"message": {
"entityUuid": [
"Not a valid UUID."
]
}
}
],
"2": [
{
"code": "event_model_does_not_exist",
"message": {
"eventModelUuid": [
"Not a valid UUID."
]
}
}
]
}
}