Sending messages
You can send the following types of messages:
- Send data from a device to a registry using the
$devices/<device ID>/eventsor$registries/<registry ID>/eventstopics. - Send data from a device to a registry using the permanent
$devices/<device ID>/stateor$registries/< registry ID>/statetopics. - Send registry commands to a device using the
$devices/<device ID>/commandsor$registries/<registry ID>/commandstopics. - Send registry commands to a device using the permanent
$devices/<device ID>/configor$registries/<registry ID>/configtopics.
To receive messages, you need to subscribe to the sender. For information about how to do this, see Subscribing a device or registry to receive messages.
Warning
Registry and device topics are not interconnected. If a device sends data to the device topic for telemetry data, you can only receive it by subscribing to this topic. The same is true for registry topics.
Before you start
Prepare the resources you need to get started:
- (optional) Create registry and device certificates.
- Create a registry.
- Add a certificate to the registry.
- Create a device.
- Add a certificate to the device.
Authorization
To send messages, you need to log in. To do this, use an X.509 certificate or username and password. This section provides examples for both authorization methods.
Sending a message with data
Note
If you encounter an error while running the command, add the --debug flag to the command and try again. This flag outputs the debug log when running the command, which helps you diagnose the problem.
Send data from a device to a device topic
Registries subscribed to this topic will know which device sent the data, because the topic contains a unique device ID.
If you don't have the Yandex.Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.
-
Send data to a device topic using certificate-based authorization:
$ yc iot mqtt publish \ --cert device-cert.pem \ --key device-key.pem \ --topic '$devices/<device ID>/events' \ --message 'Test data' \ --qos 1 -
Send data to the permanent topic of a device using certificate-based authorization:
$ yc iot mqtt publish \ --cert device-cert.pem \ --key device-key.pem \ --topic '$devices/<device ID>/state' \ --message 'Test data' \ --qos 1Where:
--certand--key: Parameters for authorization using a certificate.--topic: Device topic for sending data.--message: Message text.--qos: Quality of service (QoS).
-
Send data to a device topic using username and password authorization:
$ yc iot mqtt publish \ --username <device ID> \ --password <device password> \ --topic '$devices/<device ID>/events' \ --message 'Test data' \ --qos 1 -
Send data to the permanent topic of a device using username and password authorization:
$ yc iot mqtt publish \ --username <device ID> \ --password <device password> \ --topic '$devices/<device ID>/state' \ --message 'Test data' \ --qos 1Where:
--usernameand--password: Parameters for authorization using a username and password.--topic: Device topic for sending data.--message: Message text.--qos: Quality of service (QoS).
Send data from a device to a registry topic
The registry subscribed to this topic will not know which device sent the data, because the topic doesn't contain a unique device ID.
If you don't have the Yandex.Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.
-
Send data to a registry topic using certificate-based authorization:
$ yc iot mqtt publish \ --cert device-cert.pem \ --key device-key.pem \ --topic '$registries/<registry ID>/events' \ --message 'Test data' \ --qos 1 -
Send data to the permanent topic of a registry using certificate-based authorization:
$ yc iot mqtt publish \ --cert device-cert.pem \ --key device-key.pem \ --topic '$registries/<registry ID>/state' \ --message 'Test data' \ --qos 1Where:
--certand--key: Parameters for authorization using a certificate.--topic: Registry topic for getting data.--message: Message text.--qos: Quality of service (QoS).
-
Send data to a registry topic using username and password authorization:
$ yc iot mqtt publish \ --username <device ID> \ --password <device password> \ --topic '$registries/<registry ID>/events' \ --message 'Test data' \ --qos 1 -
Send data to the permanent topic of a registry using username and password authorization:
$ yc iot mqtt publish \ --username <device ID> \ --password <device password> \ --topic '$registries/<registry ID>/state' \ --message 'Test data' \ --qos 1Where:
--usernameand--password: Parameters for authorization using a username and password.--topic: Registry topic for getting data.--message: Message text.--qos: Quality of service (QoS).
Sending messages with commands
A registry can send messages with commands to one, multiple, or all devices added to it. Let's look at all the options.
Note
If you encounter an error while running the command, add the --debug flag to the command and try again. This flag outputs the debug log when running the command, which helps you diagnose the problem.
Send a command to a single device
If you don't have the Yandex.Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.
-
Send a command using certificate-based authorization:
$ yc iot mqtt publish \ --cert registry-cert.pem \ --key registry-key.pem \ --topic '$devices/<device ID>/commands' \ --message 'Test command for first device' \ --qos 1 -
Send a command using a permanent topic and certificate-based authorization:
$ yc iot mqtt publish \ --cert registry-cert.pem \ --key registry-key.pem \ --topic '$devices/<device ID>/config' \ --message 'Test command for first device' \ --qos 1Where:
--certand--key: Parameters for authorization using a certificate.--topic: Device topic for getting commands.--message: Message text.--qos: Quality of service (QoS).
-
Send a command using username and password authorization:
$ yc iot mqtt publish \ --username <registry ID> \ --password <registry password> \ --topic '$devices/<device ID>/commands' \ --message 'Test command for first device' \ --qos 1 -
Send a command using a permanent topic and username and password authorization:
$ yc iot mqtt publish \ --username <registry ID> \ --password <registry password> \ --topic '$devices/<device ID>/config' \ --message 'Test command for first device' \ --qos 1Where:
--usernameand--password: Parameters for authorization using a username and password.--topic: Device topic for getting commands.--message: Message text.--qos: Quality of service (QoS).
Send a command to all devices added to the registry
If you don't have the Yandex.Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.
-
Send a command to all devices using certificate-based authorization:
$ yc iot mqtt publish \ --cert registry-cert.pem \ --key registry-key.pem \ --topic '$registries/<registry ID>/commands' \ --message 'Test command for all devices' \ --qos 1 -
Send a command to all devices using a permanent topic and certificate-based authorization:
$ yc iot mqtt publish \ --cert registry-cert.pem \ --key registry-key.pem \ --topic '$registries/<registry ID>/config' \ --message 'Test command for all devices' \ --qos 1Where:
--certand--key: Parameters for authorization using a certificate.--topic: Registry topic for sending commands.--message: Message text.--qos: Quality of service (QoS).
-
Send a command to all devices using username and password authorization:
$ yc iot mqtt publish \ --username <registry ID> \ --password <registry password> \ --topic '$registries/<registry ID>/commands' \ --message 'Test command for all devices' \ --qos 1 -
Send a command to all devices using a permanent topic and username and password authorization:
$ yc iot mqtt publish \ --username <registry ID> \ --password <registry password> \ --topic '$registries/<registry ID>/config' \ --message 'Test command for all devices' \ --qos 1Where:
--usernameand--password: Parameters for authorization using a username and password.--topic: Registry topic for sending commands.--message: Message text.--qos: Quality of service (QoS).