Azure IoT middleware for FreeRTOS
azure_iot_hub_client_properties.h
Go to the documentation of this file.
1 /* Copyright (c) Microsoft Corporation.
2  * Licensed under the MIT License. */
3 
16 #ifndef AZURE_IOT_HUB_CLIENT_PROPERTIES_H
17 #define AZURE_IOT_HUB_CLIENT_PROPERTIES_H
18 
19 #include <stdbool.h>
20 #include <stdint.h>
21 
22 #include "azure_iot_hub_client.h"
23 #include "azure_iot_json_reader.h"
24 #include "azure_iot_json_writer.h"
25 
26 /* Azure SDK for Embedded C includes */
27 #include "azure/iot/az_iot_hub_client_properties.h"
28 #include "azure/core/_az_cfg_prefix.h"
29 
64  AzureIoTJSONWriter_t * pxJSONWriter,
65  const uint8_t * pucComponentName,
66  uint16_t usComponentNameLength );
67 
86  AzureIoTJSONWriter_t * pxJSONWriter );
87 
164  AzureIoTJSONWriter_t * pxJSONWriter,
165  const uint8_t * pucPropertyName,
166  uint16_t usPropertyNameLength,
167  int32_t lAckCode,
168  int32_t lAckVersion,
169  const uint8_t * pucAckDescription,
170  uint16_t usAckDescriptionLength );
171 
188  AzureIoTJSONWriter_t * pxJSONWriter );
189 
215  AzureIoTJSONReader_t * pxJSONReader,
216  AzureIoTHubMessageType_t xResponseType,
217  uint32_t * pulVersion );
218 
224 {
226  eAzureIoTHubClientReportedFromDevice = AZ_IOT_HUB_CLIENT_PROPERTY_REPORTED_FROM_DEVICE,
228  eAzureIoTHubClientPropertyWritable = AZ_IOT_HUB_CLIENT_PROPERTY_WRITABLE
230 
310  AzureIoTJSONReader_t * pxJSONReader,
311  AzureIoTHubMessageType_t xResponseType,
312  AzureIoTHubClientPropertyType_t xPropertyType,
313  const uint8_t ** ppucComponentName,
314  uint32_t * pulComponentNameLength );
315 
316 #include "azure/core/_az_cfg_suffix.h"
317 
318 #endif /*AZURE_IOT_HUB_CLIENT_PROPERTIES_H */
The middleware IoT Hub Client used to connect a device to Azure IoT Hub.
enum AzureIoTHubMessageType AzureIoTHubMessageType_t
Enumeration to dictate Azure IoT message types.
AzureIoTResult_t AzureIoTHubClientProperties_GetPropertiesVersion(AzureIoTHubClient_t *pxAzureIoTHubClient, AzureIoTJSONReader_t *pxJSONReader, AzureIoTHubMessageType_t xResponseType, uint32_t *pulVersion)
Read the Azure IoT Plug and Play property version.
AzureIoTResult_t AzureIoTHubClientProperties_BuilderEndResponseStatus(AzureIoTHubClient_t *pxAzureIoTHubClient, AzureIoTJSONWriter_t *pxJSONWriter)
End a properties response payload with confirmation status.
AzureIoTHubClientPropertyType_t
Property type.
Definition: azure_iot_hub_client_properties.h:224
@ eAzureIoTHubClientReportedFromDevice
Property was originally reported from the device.
Definition: azure_iot_hub_client_properties.h:226
@ eAzureIoTHubClientPropertyWritable
Property was received from the service.
Definition: azure_iot_hub_client_properties.h:228
AzureIoTResult_t AzureIoTHubClientProperties_BuilderBeginResponseStatus(AzureIoTHubClient_t *pxAzureIoTHubClient, AzureIoTJSONWriter_t *pxJSONWriter, const uint8_t *pucPropertyName, uint16_t usPropertyNameLength, int32_t lAckCode, int32_t lAckVersion, const uint8_t *pucAckDescription, uint16_t usAckDescriptionLength)
Begin a property response to a writable property request from the service.
AzureIoTResult_t AzureIoTHubClientProperties_BuilderBeginComponent(AzureIoTHubClient_t *pxAzureIoTHubClient, AzureIoTJSONWriter_t *pxJSONWriter, const uint8_t *pucComponentName, uint16_t usComponentNameLength)
Append the necessary characters to a reported properties JSON payload belonging to a component.
AzureIoTResult_t AzureIoTHubClientProperties_BuilderEndComponent(AzureIoTHubClient_t *pxAzureIoTHubClient, AzureIoTJSONWriter_t *pxJSONWriter)
Append the necessary characters to end a reported properties JSON payload belonging to a component.
AzureIoTResult_t AzureIoTHubClientProperties_GetNextComponentProperty(AzureIoTHubClient_t *pxAzureIoTHubClient, AzureIoTJSONReader_t *pxJSONReader, AzureIoTHubMessageType_t xResponseType, AzureIoTHubClientPropertyType_t xPropertyType, const uint8_t **ppucComponentName, uint32_t *pulComponentNameLength)
Iteratively read the Azure IoT Plug and Play component properties.
The JSON reader used by the middleware for PnP properties.
The JSON writer used by the middleware for PnP properties.
enum AzureIoTResult AzureIoTResult_t
The results used by the middleware.
Azure IoT Hub Client used to manage connections and features for Azure IoT Hub.
The struct to use for Azure IoT JSON reader functionality.
Definition: azure_iot_json_reader.h:50
The struct to use for Azure IoT JSON writer functionality.
Definition: azure_iot_json_writer.h:32