Factory Config Library API

The Factory Config library of the AIROC BTSDK provides a simple method for an application to read from the static section of the flash items that has been typically programmed in the factory. More...

Macros
#define	WICED_BT_FACTORY_PROVISIONING_RECORD_OFFSET   WICED_BT_FACTORY_CONFIG_ITEM_BASE_URI
#define	WICED_BT_FACTORY_PROVISIONING_RECORD_SIZE   WICED_BT_FACTORY_CONFIG_ITEM_APPEARANCE - WICED_BT_FACTORY_CONFIG_ITEM_BASE_URI + 1

Functions
uint16_t	wiced_bt_factory_config_read (uint8_t item_type, uint8_t *buffer, uint16_t read_size, uint16_t read_offset, uint16_t *record_size)
uint16_t	wiced_bt_factory_config_provisioning_records_get (uint16_t *buffer)
uint16_t	wiced_bt_factory_config_provisioning_record_req (uint16_t record_id, uint8_t *buffer, uint16_t fragment_length, uint16_t fragment_offset, uint16_t *record_size)

Factory Configuration Item Types
The following is the list of items types that can be programmed in the flash
#define	WICED_BT_FACTORY_CONFIG_ITEM_FIRST   0x80
#define	WICED_BT_FACTORY_CONFIG_ITEM_BASE_URI   0xC0
#define	WICED_BT_FACTORY_CONFIG_ITEM_DEVICE_CERTIFICATE   0xC1
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_1   0xC2
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_2   0xC3
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_3   0xC4
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_4   0xC5
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_5   0xC6
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_6   0xC7
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_7   0xC8
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_8   0xC9
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_9   0xCA
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_A   0xC8
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_B   0xCC
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_C   0xCD
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_D   0xCE
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_E   0xCF
#define	WICED_BT_FACTORY_CONFIG_ITEM_INTERMEDIATE_CERTIFICATE_F   0xD0
#define	WICED_BT_FACTORY_CONFIG_ITEM_LOCAL_NAME   0xD1
#define	WICED_BT_FACTORY_CONFIG_ITEM_APPEARANCE   0xD2
#define	WICED_BT_FACTORY_CONFIG_ITEM_UUID   0xE0
#define	WICED_BT_FACTORY_CONFIG_ITEM_OOB_STATIC_DATA   0xE1
#define	WICED_BT_FACTORY_CONFIG_ITEM_HOMEKIT_TOKEN   0xE2
#define	WICED_BT_FACTORY_CONFIG_ITEM_PRIVATE_KEY   0xE3
#define	WICED_BT_FACTORY_CONFIG_ITEM_LAST   0xEF

Detailed Description

The Factory Config library of the AIROC BTSDK provides a simple method for an application to read from the static section of the flash items that has been typically programmed in the factory.

Function Documentation

uint16_t wiced_bt_factory_config_provisioning_record_req	(	uint16_t	record_id,
		uint8_t *	buffer,
		uint16_t	fragment_length,
		uint16_t	fragment_offset,
		uint16_t *	record_size
	)

The application calls this API to get list of IDs of the provisioning records programmed in the static section of flash.

Parameters

record_id	: record list of IDs
buffer	: pointer to the memory buffer to store the record fragment
fragment_length	: length of the record fragment to read
fragment_offset	: start offset of the record fragment
record_size	: pointer to output parameter to save the total record size

Returns

number of provisioning record IDs found

uint16_t wiced_bt_factory_config_provisioning_records_get

(

uint16_t *

buffer

)

The application calls this API to get list of IDs of the provisioning records programmed in the static section of flash.

Parameters

buffer

: pointer to the memory buffer to store the record list of IDs

Returns

number of provisioning record IDs found

uint16_t wiced_bt_factory_config_read	(	uint8_t	item_type,
		uint8_t *	buffer,
		uint16_t	read_size,
		uint16_t	read_offset,
		uint16_t *	record_size
	)

The application calls this API to retrieve data programmed in the static section of flash. If entry with specified type is stored in the static section, the function copies data or requested chunk of it from the flash into the application buffer and returns number of bytes that has been copied. If entry with specified type does not exist in the static section of the flash, the function returns zero.

Parameters

type	: one of the WICED_BT_FACTORY_CONFIG_IDS types
buffer	: application buffer to return
read_size	: number of bytes to read
read_offset	: read offset from the start of the record
record_size	: output parameter indicating total size of the record

Returns

number of bytes copied from the flash, or zero if item not found.