Proto file udmi.proto

Service: UdmiService

UdmiService defines the service needed to add UDMI support to a driver or system. The implementer is responsible for message payloads and topic definitions. This will not be validated.

Method	Request Type	Response Type	Description
PullControlTopics	PullControlTopicsRequest	PullControlTopicsResponse stream	PullControlTopics returns a stream of topics the implementer is interested in subscribing to. Each response will include all topics, any sent previously can be discarded. (usually config topics, https://faucetsdn.github.io/udmi/docs/messages/config.html)
OnMessage	OnMessageRequest	OnMessageResponse	If the implementer lists topics in any PullControlTopicsResponse, then each message received via the MQTT broker will invoke a call to this method
PullExportMessages	PullExportMessagesRequest	PullExportMessagesResponse stream	PullExportMessages, which are to be published to the MQTT broker for data export
GetExportMessage	GetExportMessageRequest	MqttMessage	GetExportMessage returns a single MqttMessage. Servers may return the last message returned by PullExportMessages, or collect data explicitly to return. If the server does not have a message to return, it may return an Unavailable error.

PullControlTopicsRequest

Field Name	Type	Description
name	string

PullControlTopicsResponse

Field Name	Type	Description
name	string
topics	repeated string

OnMessageRequest

Field Name	Type	Description
name	string
message	MqttMessage

OnMessageResponse

Field Name	Type	Description
name	string

PullExportMessagesRequest

Field Name	Type	Description
name	string
include_last	bool	When true the last sent message will be sent immediately as the first message in the response stream.

PullExportMessagesResponse

Field Name	Type	Description
name	string
message	MqttMessage

GetExportMessageRequest

Field Name	Type	Description
name	string

MqttMessage

Field Name	Type	Description
topic	string
payload	string