zaf_config_api.h File Reference

#include <stdbool.h>
#include <stdint.h>
#include <ZW_classcmd.h>

Include dependency graph for zaf_config_api.h:

Go to the source code of this file.

Functions
uint8_t	zaf_config_get_bootloader_upgradable (void)
	Indicates if the bootloader is upgradable.
uint8_t	zaf_config_get_bootloader_target_id (void)
	Returns the target id of the bootloader.
uint16_t	zaf_config_get_build_no (void)
	Return the build number.
uint8_t	zaf_config_get_hardware_version (void)
uint8_t	zaf_config_get_firmware_target_count (void)
uint16_t	zaf_config_get_manufacturer_id (void)
uint16_t	zaf_config_get_product_type_id (void)
uint16_t	zaf_config_get_product_id (void)
uint8_t	zaf_config_get_number_of_endpoints (void)
uint8_t	zaf_config_get_default_endpoint (void)
uint8_t	zaf_config_get_role_type (void)
uint8_t	zaf_config_get_requested_security_keys (void)
uint8_t	zaf_config_get_secure_only (void)

Detailed Description

Copyright

2022 Silicon Laboratories Inc.

Function Documentation

zaf_config_get_bootloader_target_id()

uint8_t zaf_config_get_bootloader_target_id

(

void

)

Returns the target id of the bootloader.

This function is only relevant if zaf_config_get_bootloader_upgradable is true. The returned target id can be invalid if the bootloader is not upgradable

Returns

uint8_t the bootloader target id

zaf_config_get_bootloader_upgradable()

uint8_t zaf_config_get_bootloader_upgradable

(

void

)

Indicates if the bootloader is upgradable.

Returns

uint8_t 1 if the bootloader is upgradable else 0

zaf_config_get_build_no()

uint16_t zaf_config_get_build_no

(

void

)

Return the build number.

Returns

uint16_t the build number

zaf_config_get_default_endpoint()

uint8_t zaf_config_get_default_endpoint

(

void

)

Return default endpoint.

Note

Usage: in cases when command was sent to root, and endpoints are supported. Then root device should mirror endpoint 1. If there is no endpoints, endpoint 0 is used.

Returns

0 if no endpoints, or 1 if endpoints are supported

zaf_config_get_firmware_target_count()

uint8_t zaf_config_get_firmware_target_count

(

void

)

Returns the configured hardware version.

Returns

hardware version

zaf_config_get_hardware_version()

uint8_t zaf_config_get_hardware_version

(

void

)

Returns the configured hardware version.

Returns

hardware version

zaf_config_get_manufacturer_id()

uint16_t zaf_config_get_manufacturer_id

(

void

)

Returns the manufacturer ID defined in zaf_config.h

The format of this value is specified by the Manufacturer Specific command class.

Returns

Manufacturer ID

zaf_config_get_number_of_endpoints()

uint8_t zaf_config_get_number_of_endpoints

(

void

)

Returns the number of endpoints set in zaf_config.h.

Returns

Number of endpoints

zaf_config_get_product_id()

uint16_t zaf_config_get_product_id

(

void

)

Returns the product ID defined in zaf_config.h.

The format of this value is specified by the Manufacturer Specific command class.

Returns

Product ID

zaf_config_get_product_type_id()

uint16_t zaf_config_get_product_type_id

(

void

)

Returns the product type ID defined in zaf_config.h.

The format of this value is specified by the Manufacturer Specific command class.

Returns

Product type ID

zaf_config_get_requested_security_keys()

uint8_t zaf_config_get_requested_security_keys

(

void

)

Retuns the requested security keys

Returns

uint8_t Requested security keys

zaf_config_get_role_type()

uint8_t zaf_config_get_role_type

(

void

)

Returns the role type of the application.

Returns

Role type.

zaf_config_get_secure_only()

uint8_t zaf_config_get_secure_only

(

void

)

Returns if the application is secure only

Returns

uint8_t 1 for secure only else 0