FleetProvisioning_GetRegisterThingTopic

Populate the topic string for a Fleet Provisioning RegisterThing topic.

FleetProvisioningStatus_t FleetProvisioning_GetRegisterThingTopic( char * pTopicBuffer,
                                                                   uint16_t bufferLength,
                                                                   FleetProvisioningFormat_t format,
                                                                   FleetProvisioningApiTopics_t topic,
                                                                   const char * pTemplateName,
                                                                   uint16_t templateNameLength,
                                                                   uint16_t * pOutLength );

Parameters

[out]	pTopicBuffer	The buffer to write the topic string into.
[in]	bufferLength	The length of pTopicBuffer.
[in]	format	The desired RegisterThing format.
[in]	topic	The desired RegisterThing topic.
[in]	pTemplateName	The name of the provisioning template configured with AWS IoT.
[in]	templateNameLength	The length of the provisioning template name.
[out]	pOutLength	The length of the topic string written to the buffer.

Returns

FleetProvisioningSuccess if the topic string is written to the buffer; FleetProvisioningBadParameter if invalid parameters, such as non-RegisterThing topics, are passed; FleetProvisioningBufferTooSmall if the buffer cannot hold the full topic string.

example

// The following example shows how to use the FleetProvisioning_GetRegisterThingTopic
// function to generate a topic string for getting an accepted response for
// a JSON RegisterThing request.
 
#define TOPIC_BUFFER_LENGTH      ( 256u )
 
// In order to use the AWS IoT Fleet Provisioning service, there must be a
// provisioning template registered with AWS IoT Core.
// This example assumes that the template is named "template_name".
#define TEMPLATE_NAME "template_name"
#define TEMPLATE_NAME_LENGTH ( ( uint16_t ) ( sizeof( TEMPLATE_NAME ) - 1U )
char pTopicbuffer[ TOPIC_BUFFER_LENGTH ] = { 0 };
uint16_t topicLength = 0;
FleetProvisioningStatus_t status = FleetProvisioningError;
 
status = FleetProvisioning_GetRegisterThingTopic( pTopicBuffer,
                                                  TOPIC_BUFFER_LENGTH,
                                                  FleetProvisioningJson,
                                                  FleetProvisioningAccepted,
                                                  TEMPLATE_NAME,
                                                  TEMPLATE_NAME_LENGTH,
                                                  &( topiclength ) );
 
if( status == FleetProvisioningSuccess )
{
     // The buffer pTopicBuffer contains the topic string of length
     // topicLength for getting a response for an accepted JSON RegisterThing
     // request. Subscribe to this topic using an MQTT library of your choice.
}