#include "nx_azure_iot_pnp_client.h"
Go to the source code of this file.
|
| UINT | nx_azure_iot_pnp_client_reported_component_property_value_next (NX_AZURE_IOT_PNP_CLIENT *pnp_client_ptr, NX_AZURE_IOT_JSON_READER *reader_ptr, UINT message_type, const UCHAR **component_pptr, UINT *component_len_ptr, NX_AZURE_IOT_JSON_READER *name_value_reader_ptr) |
| | Return the next reported property in the property document passed. More...
|
| |
| UINT | nx_azure_iot_pnp_client_telemetry_message_create_with_message_property (NX_AZURE_IOT_PNP_CLIENT *pnp_client_ptr, const UCHAR *component_name_ptr, UINT component_name_length, NX_PACKET **packet_pptr, UINT wait_option, UCHAR *message_properties_buffer, UINT message_properties_buffer_size) |
| | Create a telemetry property packet (NX PACKET) to be sent along with telemetry from the properties buffer containing properties (like status of each component) to be sent. More...
|
| |
◆ nx_azure_iot_pnp_client_reported_component_property_value_next()
| UINT nx_azure_iot_pnp_client_reported_component_property_value_next |
( |
NX_AZURE_IOT_PNP_CLIENT * |
pnp_client_ptr, |
|
|
NX_AZURE_IOT_JSON_READER * |
reader_ptr, |
|
|
UINT |
message_type, |
|
|
const UCHAR ** |
component_pptr, |
|
|
UINT * |
component_len_ptr, |
|
|
NX_AZURE_IOT_JSON_READER * |
name_value_reader_ptr |
|
) |
| |
Return the next reported property in the property document passed.
- Parameters
-
| [in] | pnp_client_ptr | A pointer to a #NX_AZURE_IOT_PNP_CLIENT. |
| [in] | reader_ptr | A pointer to a #NX_AZURE_IOT_JSON_READER containing properties document |
| [in] | message_type | Type of document, only valid value are NX_AZURE_IOT_PNP_DESIRED_PROPERTIES or NX_AZURE_IOT_PNP_PROPERTIES |
| [out] | component_pptr | A pointer to component name for the property returned using name_value_reader_ptr |
| [out] | component_len_ptr | Length of the component name |
| [out] | name_value_reader_ptr | A pointer to a #NX_AZURE_IOT_JSON_READER containing property name and value |
- Returns
- A
UINT with the result of the API.
- Return values
-
| #NX_AZURE_IOT_SUCCESS | Successful if next desired property is found. |
◆ nx_azure_iot_pnp_client_telemetry_message_create_with_message_property()
| UINT nx_azure_iot_pnp_client_telemetry_message_create_with_message_property |
( |
NX_AZURE_IOT_PNP_CLIENT * |
pnp_client_ptr, |
|
|
const UCHAR * |
component_name_ptr, |
|
|
UINT |
component_name_length, |
|
|
NX_PACKET ** |
packet_pptr, |
|
|
UINT |
wait_option, |
|
|
UCHAR * |
message_properties_buffer, |
|
|
UINT |
message_properties_buffer_size |
|
) |
| |
Create a telemetry property packet (NX PACKET) to be sent along with telemetry from the properties buffer containing properties (like status of each component) to be sent.
- Parameters
-
| [in] | pnp_client_ptr | A pointer to a #NX_AZURE_IOT_PNP_CLIENT. |
| [in] | component_ptr | A pointer to component name for which the property packet needs to be created. |
| [in] | component_len_ptr | Length of the component name. |
| [out] | packet_pptr | A pointer telemetry property packet which this function will create. |
| [in] | wait_option | A NetX library wait option. Defines the number of ThreadX timer ticks to wait for a ping response |
| [in] | message_properties_buffer | Buffer containing properties to be sent as telemetry property packet. |
| [in] | message_properties_buffer_size | Size of the buffer containing properties to be sent as telemetry property packet. |
- Return values
-
| #NX_AZURE_IOT_SUCCESS | Successful if next desired property is found. |
