CC_ManufacturerSpecific.h File Reference

#include <stdint.h>

Include dependency graph for CC_ManufacturerSpecific.h:

Go to the source code of this file.

Enumerations
enum	device_id_type_t {   DEVICE_ID_TYPE_OEM = 0 ,   DEVICE_ID_TYPE_SERIAL_NUMBER ,   DEVICE_ID_TYPE_PSEUDO_RANDOM ,   NUMBER_OF_DEVICE_ID_TYPES }
enum	device_id_format_t {   DEVICE_ID_FORMAT_UTF_8 = 0 ,   DEVICE_ID_FORMAT_BINARY ,   NUMBER_OF_DEVICE_ID_FORMATS }

Functions
void	CC_ManufacturerSpecific_ManufacturerSpecificGet_handler (uint16_t *pManufacturerID, uint16_t *pProductTypeID, uint16_t *pProductID)
void	CC_ManufacturerSpecific_DeviceSpecificGet_handler (device_id_type_t *pDeviceIDType, device_id_format_t *pDeviceIDDataFormat, uint8_t *pDeviceIDDataLength, uint8_t *pDeviceIDData)

Detailed Description

Defines weak functions for overriding statically configured data with runtime data.

SPDX-License-Identifier: BSD-3-Clause SPDX-FileCopyrightText: 2023 Z-Wave-Alliance https://z-wavealliance.org/

Enumeration Type Documentation

device_id_format_t

enum device_id_format_t

Command class manufacturer specific device Id format

Enumerator
DEVICE_ID_FORMAT_UTF_8
DEVICE_ID_FORMAT_BINARY
NUMBER_OF_DEVICE_ID_FORMATS

device_id_type_t

enum device_id_type_t

Command class manufacturer specific device Id type

Enumerator
DEVICE_ID_TYPE_OEM
DEVICE_ID_TYPE_SERIAL_NUMBER
DEVICE_ID_TYPE_PSEUDO_RANDOM
NUMBER_OF_DEVICE_ID_TYPES

Function Documentation

CC_ManufacturerSpecific_DeviceSpecificGet_handler()

void CC_ManufacturerSpecific_DeviceSpecificGet_handler	(	device_id_type_t *	pDeviceIDType,
		device_id_format_t *	pDeviceIDDataFormat,
		uint8_t *	pDeviceIDDataLength,
		uint8_t *	pDeviceIDData )

Writes the device ID and related values into the given variables.

This function is weakly defined within the command class and can be defined by the application if desired.

Parameters

[in,out]	pDeviceIDType	Pointer to device ID type.
[out]	pDeviceIDDataFormat	Pointer to device ID data format.
[out]	pDeviceIDDataLength	Pointer to device ID data length.
[out]	pDeviceIDData	Pointer to device ID data.

CC_ManufacturerSpecific_ManufacturerSpecificGet_handler()

void CC_ManufacturerSpecific_ManufacturerSpecificGet_handler	(	uint16_t *	pManufacturerID,
		uint16_t *	pProductTypeID,
		uint16_t *	pProductID )

Writes the manufacturer ID, product type ID and product ID into the given variables.

This function is weakly defined within the command class and can be defined by the application if desired.

Parameters

[out]	pManufacturerID	Pointer to manufacturer ID.
[out]	pProductTypeID	Pointer to product type ID.
[out]	pProductID	Pointer to product ID.