this is fork and i will modify for STM32
Fork of AWS-test by
aws_iot_shadow_json_data.h File Reference
This file is the interface for all the Shadow related JSON functions. More...
Go to the source code of this file.
Data Structures | |
struct | jsonStruct |
This is the struct form of a JSON Key value pair. More... | |
Typedefs | |
typedef struct jsonStruct | jsonStruct_t |
This is a static JSON object that could be used in code. | |
typedef void(* | jsonStructCallback_t )(const char *pJsonValueBuffer, uint32_t valueLength, jsonStruct_t *pJsonStruct_t) |
Every JSON name value can have a callback. | |
Enumerations | |
enum | JsonPrimitiveType |
All the JSON object types enum. More... | |
Functions | |
IoT_Error_t | aws_iot_shadow_init_json_document (char *pJsonDocument, size_t maxSizeOfJsonDocument) |
Initialize the JSON document with Shadow expected name/value. | |
IoT_Error_t | aws_iot_shadow_add_reported (char *pJsonDocument, size_t maxSizeOfJsonDocument, uint8_t count,...) |
Add the reported section of the JSON document of jsonStruct_t. | |
IoT_Error_t | aws_iot_shadow_add_desired (char *pJsonDocument, size_t maxSizeOfJsonDocument, uint8_t count,...) |
Add the desired section of the JSON document of jsonStruct_t. | |
IoT_Error_t | aws_iot_finalize_json_document (char *pJsonDocument, size_t maxSizeOfJsonDocument) |
Finalize the JSON document with Shadow expected client Token. | |
IoT_Error_t | aws_iot_fill_with_client_token (char *pBufferToBeUpdatedWithClientToken, size_t maxSizeOfJsonDocument) |
Fill the given buffer with client token for tracking the Repsonse. |
Detailed Description
This file is the interface for all the Shadow related JSON functions.
Definition in file aws_iot_shadow_json_data.h.
Typedef Documentation
typedef struct jsonStruct jsonStruct_t |
This is a static JSON object that could be used in code.
Definition at line 34 of file aws_iot_shadow_json_data.h.
typedef void(* jsonStructCallback_t)(const char *pJsonValueBuffer, uint32_t valueLength, jsonStruct_t *pJsonStruct_t) |
Every JSON name value can have a callback.
The callback should follow this signature
Definition at line 39 of file aws_iot_shadow_json_data.h.
Enumeration Type Documentation
enum JsonPrimitiveType |
All the JSON object types enum.
JSON number types need to be split into proper integer / floating point data types and sizes on embedded platforms.
Definition at line 46 of file aws_iot_shadow_json_data.h.
Function Documentation
IoT_Error_t aws_iot_fill_with_client_token | ( | char * | pBufferToBeUpdatedWithClientToken, |
size_t | maxSizeOfJsonDocument | ||
) |
Fill the given buffer with client token for tracking the Repsonse.
This function will add the AWS_IOT_MQTT_CLIENT_ID with a sequence number. Every time this function is used the sequence number gets incremented
- Parameters:
-
pBufferToBeUpdatedWithClientToken buffer to be updated with the client token string maxSizeOfJsonDocument maximum size of the pBufferToBeUpdatedWithClientToken that can be used
- Returns:
- An IoT Error Type defining if the buffer was null or the entire string was not filled up
Definition at line 225 of file aws_iot_shadow_json.cpp.
IoT_Error_t aws_iot_finalize_json_document | ( | char * | pJsonDocument, |
size_t | maxSizeOfJsonDocument | ||
) |
Finalize the JSON document with Shadow expected client Token.
This function will automatically increment the client token every time this function is called.
- Note:
- Ensure the size of the Buffer is enough to hold the entire JSON Document. If the finalized section is not invoked then the JSON doucment will not be valid
- Parameters:
-
pJsonDocument The JSON Document filled in this char buffer maxSizeOfJsonDocument maximum size of the pJsonDocument that can be used to fill the JSON document
- Returns:
- An IoT Error Type defining if the buffer was null or the entire string was not filled up
Definition at line 233 of file aws_iot_shadow_json.cpp.
IoT_Error_t aws_iot_shadow_add_desired | ( | char * | pJsonDocument, |
size_t | maxSizeOfJsonDocument, | ||
uint8_t | count, | ||
... | |||
) |
Add the desired section of the JSON document of jsonStruct_t.
This is a variadic function and please be careful with the usage. count is the number of jsonStruct_t types that you would like to add in the reported section This function will add "desired":{<all the="" values="" that="" needs="" to="" be="" added>="">}
- Note:
- Ensure the size of the Buffer is enough to hold the reported section + the init section. Always use the same JSON document buffer used in the iot_shadow_init_json_document function. This function will accommodate the size of previous null terminated string, so pass the max size of the buffer
- Parameters:
-
pJsonDocument The JSON Document filled in this char buffer maxSizeOfJsonDocument maximum size of the pJsonDocument that can be used to fill the JSON document count total number of arguments(jsonStruct_t object) passed in the arguments
- Returns:
- An IoT Error Type defining if the buffer was null or the entire string was not filled up
Definition at line 91 of file aws_iot_shadow_json.cpp.
IoT_Error_t aws_iot_shadow_add_reported | ( | char * | pJsonDocument, |
size_t | maxSizeOfJsonDocument, | ||
uint8_t | count, | ||
... | |||
) |
Add the reported section of the JSON document of jsonStruct_t.
This is a variadic function and please be careful with the usage. count is the number of jsonStruct_t types that you would like to add in the reported section This function will add "reported":{<all the="" values="" that="" needs="" to="" be="" added>="">}
- Note:
- Ensure the size of the Buffer is enough to hold the reported section + the init section. Always use the same JSON document buffer used in the iot_shadow_init_json_document function. This function will accommodate the size of previous null terminated string, so pass teh max size of the buffer
- Parameters:
-
pJsonDocument The JSON Document filled in this char buffer maxSizeOfJsonDocument maximum size of the pJsonDocument that can be used to fill the JSON document count total number of arguments(jsonStruct_t object) passed in the arguments
- Returns:
- An IoT Error Type defining if the buffer was null or the entire string was not filled up
Definition at line 152 of file aws_iot_shadow_json.cpp.
IoT_Error_t aws_iot_shadow_init_json_document | ( | char * | pJsonDocument, |
size_t | maxSizeOfJsonDocument | ||
) |
Initialize the JSON document with Shadow expected name/value.
This Function will fill the JSON Buffer with a null terminated string. Internally it uses snprintf This function should always be used First, followed by iot_shadow_add_reported and/or iot_shadow_add_desired. Always finish the call sequence with iot_finalize_json_document
- Note:
- Ensure the size of the Buffer is enough to hold the entire JSON Document.
- Parameters:
-
pJsonDocument The JSON Document filled in this char buffer maxSizeOfJsonDocument maximum size of the pJsonDocument that can be used to fill the JSON document
- Returns:
- An IoT Error Type defining if the buffer was null or the entire string was not filled up
Definition at line 75 of file aws_iot_shadow_json.cpp.
Generated on Tue Jul 12 2022 11:16:38 by 1.7.2