Imported more library files
Not compiling currently
This commit is contained in:
999
Libs/platform/radio/rail_lib/protocol/zwave/rail_zwave.h
Normal file
999
Libs/platform/radio/rail_lib/protocol/zwave/rail_zwave.h
Normal file
@@ -0,0 +1,999 @@
|
||||
/***************************************************************************//**
|
||||
* @file
|
||||
* @brief The Z-Wave specific header file for the RAIL library.
|
||||
*******************************************************************************
|
||||
* # License
|
||||
* <b>Copyright 2020 Silicon Laboratories Inc. www.silabs.com</b>
|
||||
*******************************************************************************
|
||||
*
|
||||
* SPDX-License-Identifier: Zlib
|
||||
*
|
||||
* The licensor of this software is Silicon Laboratories Inc.
|
||||
*
|
||||
* This software is provided 'as-is', without any express or implied
|
||||
* warranty. In no event will the authors be held liable for any damages
|
||||
* arising from the use of this software.
|
||||
*
|
||||
* Permission is granted to anyone to use this software for any purpose,
|
||||
* including commercial applications, and to alter it and redistribute it
|
||||
* freely, subject to the following restrictions:
|
||||
*
|
||||
* 1. The origin of this software must not be misrepresented; you must not
|
||||
* claim that you wrote the original software. If you use this software
|
||||
* in a product, an acknowledgment in the product documentation would be
|
||||
* appreciated but is not required.
|
||||
* 2. Altered source versions must be plainly marked as such, and must not be
|
||||
* misrepresented as being the original software.
|
||||
* 3. This notice may not be removed or altered from any source distribution.
|
||||
*
|
||||
******************************************************************************/
|
||||
|
||||
#ifndef __RAIL_ZWAVE_H__
|
||||
#define __RAIL_ZWAVE_H__
|
||||
|
||||
#include "rail_types.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/// @addtogroup Z_Wave Z-Wave
|
||||
/// @ingroup Protocol_Specific
|
||||
/// @brief Z-Wave configuration routines
|
||||
///
|
||||
/// The functions in this group configure RAIL Z-Wave hardware
|
||||
/// acceleration features.
|
||||
///
|
||||
/// To configure Z-Wave functionality, the application must first set up
|
||||
/// a RAIL instance with \ref RAIL_Init() and other setup functions.
|
||||
/// @code{.c}
|
||||
/// RAIL_ZWAVE_NodeId_t gRecentBeamNodeId;
|
||||
/// uint8_t gRecentBeamChannelIndex;
|
||||
///
|
||||
/// // Main RAIL_EVENT callback
|
||||
/// static void RAILCb_Event(RAIL_Handle_t railHandle, RAIL_Events_t events)
|
||||
/// {
|
||||
/// // Get beam Node Id and channel index from beam packet
|
||||
/// if (events & RAIL_EVENT_ZWAVE_BEAM) {
|
||||
/// if (RAIL_ZWAVE_IsEnabled(railHandle)) {
|
||||
/// if ((RAIL_ZWAVE_GetBeamNodeId(railHandle, &gRecentBeamNodeId)
|
||||
/// != RAIL_STATUS_NO_ERROR)
|
||||
/// || (RAIL_ZWAVE_GetBeamChannelIndex(railHandle, &gRecentBeamChannelIndex)
|
||||
/// != RAIL_STATUS_NO_ERROR)) {
|
||||
/// return;
|
||||
/// }
|
||||
/// }
|
||||
/// }
|
||||
/// }
|
||||
///
|
||||
/// static const RAIL_ZWAVE_Config_t zwaveConfig = {
|
||||
/// .options = RAIL_ZWAVE_OPTIONS_DEFAULT
|
||||
/// };
|
||||
///
|
||||
/// RAIL_Status_t zwaveInit(void)
|
||||
/// {
|
||||
/// // initialize Z-Wave
|
||||
/// RAIL_Status_t status = RAIL_ZWAVE_Init(railHandle, &zwaveConfig);
|
||||
///
|
||||
/// if (status != RAIL_STATUS_NO_ERROR) {
|
||||
/// return status;
|
||||
/// }
|
||||
///
|
||||
/// uint8_t myHomeId[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
|
||||
/// RAIL_ZWAVE_SetNodeId(railHandle, RAIL_ZWAVE_NODE_ID_DEFAULT);
|
||||
/// RAIL_ZWAVE_SetHomeId(railHandle, myHomeId, RAIL_ZWAVE_HOME_ID_HASH_DONT_CARE);
|
||||
///
|
||||
/// // configure region to EU(European Union)
|
||||
/// return RAIL_ZWAVE_ConfigRegion(railHandle, RAIL_ZWAVE_REGION_EU);
|
||||
/// }
|
||||
/// @endcode
|
||||
///
|
||||
/// @{
|
||||
|
||||
/**
|
||||
* @enum RAIL_ZWAVE_Options_t
|
||||
* @brief Z-Wave options.
|
||||
*/
|
||||
RAIL_ENUM_GENERIC(RAIL_ZWAVE_Options_t, uint32_t) {
|
||||
/** Shift position of \ref RAIL_ZWAVE_OPTION_PROMISCUOUS_MODE bit. */
|
||||
RAIL_ZWAVE_OPTION_PROMISCUOUS_MODE_SHIFT = 0,
|
||||
/** Shift position of \ref RAIL_ZWAVE_OPTION_DETECT_BEAM_FRAMES bit. */
|
||||
RAIL_ZWAVE_OPTION_DETECT_BEAM_FRAMES_SHIFT = 1,
|
||||
/** Shift position of \ref RAIL_ZWAVE_OPTION_NODE_ID_FILTERING bit. */
|
||||
RAIL_ZWAVE_OPTION_NODE_ID_FILTERING_SHIFT = 2,
|
||||
/** Shift position of \ref RAIL_ZWAVE_OPTION_PROMISCUOUS_BEAM_MODE bit. */
|
||||
RAIL_ZWAVE_OPTION_PROMISCUOUS_BEAM_MODE_SHIFT = 3,
|
||||
};
|
||||
|
||||
/** A value representing no options */
|
||||
#define RAIL_ZWAVE_OPTIONS_NONE 0U
|
||||
|
||||
/** All options are disabled by default. */
|
||||
#define RAIL_ZWAVE_OPTIONS_DEFAULT RAIL_ZWAVE_OPTIONS_NONE
|
||||
|
||||
/**
|
||||
* An option to configure promiscuous mode, accepting non-beam packets
|
||||
* regardless of their Home Id. By default packets are filtered by their Home Id.
|
||||
* When true, such filtering is disabled.
|
||||
*/
|
||||
#define RAIL_ZWAVE_OPTION_PROMISCUOUS_MODE \
|
||||
(1u << RAIL_ZWAVE_OPTION_PROMISCUOUS_MODE_SHIFT)
|
||||
|
||||
/**
|
||||
* An option to filter non-beam packets based on their Node Id when
|
||||
* \ref RAIL_ZWAVE_OPTION_PROMISCUOUS_MODE is disabled.
|
||||
*
|
||||
* @note This option has no effect when
|
||||
* \ref RAIL_ZWAVE_OPTION_PROMISCUOUS_MODE is enabled.
|
||||
*/
|
||||
#define RAIL_ZWAVE_OPTION_NODE_ID_FILTERING \
|
||||
(1u << RAIL_ZWAVE_OPTION_NODE_ID_FILTERING_SHIFT)
|
||||
|
||||
/**
|
||||
* An option to configure beam frame recognition. By default beams are not
|
||||
* considered special and will be received as if they were normal Z-Wave
|
||||
* frames, assuredly triggering \ref RAIL_EVENT_RX_FRAME_ERROR.
|
||||
* When true, beam frames that are broadcast or match the Node Id and
|
||||
* Home Id hash values will trigger \ref RAIL_EVENT_ZWAVE_BEAM event.
|
||||
* (All beams additionally trigger \ref RAIL_EVENT_RX_PACKET_ABORTED
|
||||
* regardless of Node Id / Home Id hash values.)
|
||||
*
|
||||
* @note This option takes precedence over \ref
|
||||
* RAIL_ZWAVE_OPTION_PROMISCUOUS_MODE when receiving a beam frame.
|
||||
* For promiscuous beam handling see related
|
||||
* \ref RAIL_ZWAVE_OPTION_PROMISCUOUS_BEAM_MODE option.
|
||||
*/
|
||||
#define RAIL_ZWAVE_OPTION_DETECT_BEAM_FRAMES \
|
||||
(1u << RAIL_ZWAVE_OPTION_DETECT_BEAM_FRAMES_SHIFT)
|
||||
|
||||
/**
|
||||
* An option to receive all beams promiscuously when \ref
|
||||
* RAIL_ZWAVE_OPTION_DETECT_BEAM_FRAMES is enabled.
|
||||
* When true, beam frames are received regardless of their Node Id or Home Id hash
|
||||
* resulting in \ref RAIL_EVENT_ZWAVE_BEAM (and also \ref
|
||||
* RAIL_EVENT_RX_PACKET_ABORTED) for each beam frame.
|
||||
*
|
||||
* @note This option has no effect when
|
||||
* \ref RAIL_ZWAVE_OPTION_DETECT_BEAM_FRAMES is disabled.
|
||||
*/
|
||||
#define RAIL_ZWAVE_OPTION_PROMISCUOUS_BEAM_MODE \
|
||||
(1u << RAIL_ZWAVE_OPTION_PROMISCUOUS_BEAM_MODE_SHIFT)
|
||||
|
||||
/** A value representing all options */
|
||||
#define RAIL_ZWAVE_OPTIONS_ALL 0xFFFFFFFFU
|
||||
|
||||
/**
|
||||
* @enum RAIL_ZWAVE_NodeId_t
|
||||
* @brief A Z-Wave Node Id.
|
||||
*
|
||||
* This data type is 12 bits wide when using the ZWave Long Range PHY, and
|
||||
* 8 bits wide otherwise.
|
||||
*
|
||||
* @note When using the Long Range PHY, values 0xFA1..0xFFE are reserved.
|
||||
* Otherwise, values 0xE9..0xFE are reserved.
|
||||
*/
|
||||
RAIL_ENUM_GENERIC(RAIL_ZWAVE_NodeId_t, uint16_t) {
|
||||
/** The unknown Node Id for uninitialized nodes. */
|
||||
RAIL_ZWAVE_NODE_ID_NONE = 0x00U,
|
||||
/** The broadcast Node Id. */
|
||||
RAIL_ZWAVE_NODE_ID_BROADCAST = 0xFFU,
|
||||
/** Default to the broadcast Node Id. */
|
||||
RAIL_ZWAVE_NODE_ID_DEFAULT = RAIL_ZWAVE_NODE_ID_BROADCAST,
|
||||
// All other values between 0x00 and 0xFE are valid Node Ids normally
|
||||
/** The Long Range broadcast Node Id. */
|
||||
RAIL_ZWAVE_NODE_ID_BROADCAST_LONGRANGE = 0xFFFU,
|
||||
/** Default to the Long Range broadcast Node Id. */
|
||||
RAIL_ZWAVE_NODE_ID_DEFAULT_LONGRANGE = RAIL_ZWAVE_NODE_ID_BROADCAST_LONGRANGE,
|
||||
// All values from 0x001 to 0xFA1 are valid Node Ids with a Long Range PHY.
|
||||
};
|
||||
|
||||
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
||||
// Self-referencing defines minimize compiler complaints when using RAIL_ENUM
|
||||
#define RAIL_ZWAVE_NODE_ID_NONE ((RAIL_ZWAVE_NodeId_t) RAIL_ZWAVE_NODE_ID_NONE)
|
||||
#define RAIL_ZWAVE_NODE_ID_BROADCAST ((RAIL_ZWAVE_NodeId_t) RAIL_ZWAVE_NODE_ID_BROADCAST)
|
||||
#define RAIL_ZWAVE_NODE_ID_DEFAULT ((RAIL_ZWAVE_NodeId_t) RAIL_ZWAVE_NODE_ID_DEFAULT)
|
||||
#define RAIL_ZWAVE_NODE_ID_BROADCAST_LONGRANGE ((RAIL_ZWAVE_NodeId_t) RAIL_ZWAVE_NODE_ID_BROADCAST_LONGRANGE)
|
||||
#define RAIL_ZWAVE_NODE_ID_DEFAULT_LONGRANGE ((RAIL_ZWAVE_NodeId_t) RAIL_ZWAVE_NODE_ID_DEFAULT_LONGRANGE)
|
||||
#endif //DOXYGEN_SHOULD_SKIP_THIS
|
||||
|
||||
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
||||
/** Defines for \ref RAIL_RxPacketDetails_t::subPhyId field. */
|
||||
#define RAIL_ZWAVE_RX_SUBPHY_ID_0 (0U)
|
||||
#define RAIL_ZWAVE_RX_SUBPHY_ID_1 (1U)
|
||||
#define RAIL_ZWAVE_RX_SUBPHY_ID_2 (2U)
|
||||
#define RAIL_ZWAVE_RX_SUBPHY_ID_3 (3U)
|
||||
#endif //DOXYGEN_SHOULD_SKIP_THIS
|
||||
|
||||
/**
|
||||
* @enum RAIL_ZWAVE_HomeId_t
|
||||
* @brief A Z-Wave Home Id.
|
||||
*
|
||||
* @note Home Ids in the range 0x54000000..0x55FFFFFF are illegal.
|
||||
*/
|
||||
RAIL_ENUM_GENERIC(RAIL_ZWAVE_HomeId_t, uint32_t) {
|
||||
/** The unknown Home Id. */
|
||||
RAIL_ZWAVE_HOME_ID_UNKNOWN = 0x00000000U,
|
||||
/** An impossible and unlikely Home Id. */
|
||||
RAIL_ZWAVE_HOME_ID_DEFAULT = 0x54545454U,
|
||||
};
|
||||
|
||||
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
||||
// Self-referencing defines minimize compiler complaints when using RAIL_ENUM
|
||||
#define RAIL_ZWAVE_HOME_ID_UNKNOWN ((RAIL_ZWAVE_HomeId_t) RAIL_ZWAVE_HOME_ID_UNKNOWN)
|
||||
#define RAIL_ZWAVE_HOME_ID_DEFAULT ((RAIL_ZWAVE_HomeId_t) RAIL_ZWAVE_HOME_ID_DEFAULT)
|
||||
#endif //DOXYGEN_SHOULD_SKIP_THIS
|
||||
|
||||
/**
|
||||
* @enum RAIL_ZWAVE_HomeIdHash_t
|
||||
* @brief A Z-Wave Home Id hash.
|
||||
*
|
||||
* @note Certain values (as shown) are illegal.
|
||||
*/
|
||||
RAIL_ENUM(RAIL_ZWAVE_HomeIdHash_t) {
|
||||
/** An illegal Home Id hash value. */
|
||||
RAIL_ZWAVE_HOME_ID_HASH_ILLEGAL_1 = 0x0AU,
|
||||
/** An illegal Home Id hash value. */
|
||||
RAIL_ZWAVE_HOME_ID_HASH_ILLEGAL_2 = 0x4AU,
|
||||
/** An illegal Home Id hash value. */
|
||||
RAIL_ZWAVE_HOME_ID_HASH_ILLEGAL_3 = 0x55U,
|
||||
/**
|
||||
* Illegal Home Id hash value that suppresses checking the
|
||||
* Home Id hash field of beam packets.
|
||||
*/
|
||||
RAIL_ZWAVE_HOME_ID_HASH_DONT_CARE = 0x55U,
|
||||
/** Default to don't care. */
|
||||
RAIL_ZWAVE_HOME_ID_HASH_DEFAULT = RAIL_ZWAVE_HOME_ID_HASH_DONT_CARE,
|
||||
};
|
||||
|
||||
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
||||
// Self-referencing defines minimize compiler complaints when using RAIL_ENUM
|
||||
#define RAIL_ZWAVE_HOME_ID_HASH_ILLEGAL_1 ((RAIL_ZWAVE_HomeIdHash_t) RAIL_ZWAVE_HOME_ID_HASH_ILLEGAL_1)
|
||||
#define RAIL_ZWAVE_HOME_ID_HASH_ILLEGAL_2 ((RAIL_ZWAVE_HomeIdHash_t) RAIL_ZWAVE_HOME_ID_HASH_ILLEGAL_2)
|
||||
#define RAIL_ZWAVE_HOME_ID_HASH_ILLEGAL_3 ((RAIL_ZWAVE_HomeIdHash_t) RAIL_ZWAVE_HOME_ID_HASH_ILLEGAL_3)
|
||||
#define RAIL_ZWAVE_HOME_ID_HASH_DONT_CARE ((RAIL_ZWAVE_HomeIdHash_t) RAIL_ZWAVE_HOME_ID_HASH_DONT_CARE)
|
||||
#define RAIL_ZWAVE_HOME_ID_HASH_DEFAULT ((RAIL_ZWAVE_HomeIdHash_t) RAIL_ZWAVE_HOME_ID_HASH_DEFAULT)
|
||||
#endif //DOXYGEN_SHOULD_SKIP_THIS
|
||||
|
||||
/**
|
||||
* @struct RAIL_ZWAVE_Config_t
|
||||
* @brief A configuration structure for Z-Wave in RAIL.
|
||||
*/
|
||||
typedef struct RAIL_ZWAVE_Config {
|
||||
/**
|
||||
* Defines Z-Wave options.
|
||||
*/
|
||||
RAIL_ZWAVE_Options_t options;
|
||||
/**
|
||||
* Defines Z-Wave Acking configuration.
|
||||
*/
|
||||
RAIL_AutoAckConfig_t ackConfig;
|
||||
/**
|
||||
* Defines state timings for Z-Wave.
|
||||
*/
|
||||
RAIL_StateTiming_t timings;
|
||||
} RAIL_ZWAVE_Config_t;
|
||||
|
||||
/**
|
||||
* @enum RAIL_ZWAVE_Baud_t
|
||||
* @brief Z-Wave supported baud rates or PHYs.
|
||||
*/
|
||||
RAIL_ENUM(RAIL_ZWAVE_Baud_t) {
|
||||
/** 9.6 kbps baud rate. */
|
||||
RAIL_ZWAVE_BAUD_9600,
|
||||
/** 40 kbps baud rate. */
|
||||
RAIL_ZWAVE_BAUD_40K,
|
||||
/** 100 kbps baud rate. */
|
||||
RAIL_ZWAVE_BAUD_100K,
|
||||
/** Long Range PHY. */
|
||||
RAIL_ZWAVE_LR,
|
||||
/** Energy detection PHY. */
|
||||
RAIL_ZWAVE_ENERGY_DETECT = RAIL_ZWAVE_LR,
|
||||
/** Sentinel value for invalid baud rate. Must be last. */
|
||||
RAIL_ZWAVE_BAUD_INVALID
|
||||
};
|
||||
|
||||
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
||||
// Self-referencing defines minimize compiler complaints when using RAIL_ENUM
|
||||
#define RAIL_ZWAVE_BAUD_9600 ((RAIL_ZWAVE_Baud_t) RAIL_ZWAVE_BAUD_9600)
|
||||
#define RAIL_ZWAVE_BAUD_40K ((RAIL_ZWAVE_Baud_t) RAIL_ZWAVE_BAUD_40K)
|
||||
#define RAIL_ZWAVE_BAUD_100K ((RAIL_ZWAVE_Baud_t) RAIL_ZWAVE_BAUD_100K)
|
||||
#define RAIL_ZWAVE_LR ((RAIL_ZWAVE_Baud_t) RAIL_ZWAVE_LR)
|
||||
#define RAIL_ZWAVE_ENERGY_DETECT ((RAIL_ZWAVE_Baud_t) RAIL_ZWAVE_ENERGY_DETECT)
|
||||
#define RAIL_ZWAVE_INVALID ((RAIL_ZWAVE_Baud_t) RAIL_ZWAVE_INVALID)
|
||||
#endif //DOXYGEN_SHOULD_SKIP_THIS
|
||||
|
||||
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
||||
/**
|
||||
* @enum RAIL_ZWAVE_RegionOptions_t
|
||||
* @brief Region Specific Physical
|
||||
*/
|
||||
|
||||
RAIL_ENUM(RAIL_ZWAVE_RegionOptions_t) {
|
||||
/** Bit shift for US Long Range 3 */
|
||||
RAIL_ZWAVE_REGION_LONG_RANGE_3_SHIFT = 0,
|
||||
/** Bit shift for special low side config, mostly for Japan and Korea */
|
||||
RAIL_ZWAVE_REGION_LOW_SIDE_SHIFT = 1,
|
||||
/** Bit shift for US long range range configurations */
|
||||
RAIL_ZWAVE_REGION_LONG_RANGE_SHIFT = 2,
|
||||
};
|
||||
|
||||
/**
|
||||
* RAIL_ZWAVE_RegionOptions_t bitmasks
|
||||
*/
|
||||
/** A value representing US Long Range regions */
|
||||
#define RAIL_ZWAVE_REGION_LONG_RANGE_MASK (1u << RAIL_ZWAVE_REGION_LONG_RANGE_SHIFT)
|
||||
/** A value representing lowside configurations: JP and KR */
|
||||
#define RAIL_ZWAVE_REGION_LOW_SIDE_MASK (1u << RAIL_ZWAVE_REGION_LOW_SIDE_SHIFT)
|
||||
/** A value representing Long Range 3 (end device) region */
|
||||
#define RAIL_ZWAVE_REGION_LONG_RANGE_3_MASK (1u << RAIL_ZWAVE_REGION_LONG_RANGE_3_SHIFT)
|
||||
/** @deprecated Backwards compatible name. */
|
||||
#define RAIL_ZWAVE_REGION_LONG_RANGE_END_MASK RAIL_ZWAVE_REGION_LONG_RANGE_3_MASK
|
||||
/** A value representing No bit to be enabled */
|
||||
#define RAIL_ZWAVE_REGION_SPECIFIC_NONE 0u
|
||||
#endif // DOXYGEN SHOULD SKIP THIS
|
||||
|
||||
/**
|
||||
* Sentinel value to indicate that a channel (and thus its frequency)
|
||||
* are invalid.
|
||||
*/
|
||||
#define RAIL_ZWAVE_FREQ_INVALID 0xFFFFFFFFUL
|
||||
|
||||
/**
|
||||
* @enum RAIL_ZWAVE_RegionId_t
|
||||
* @brief Z-Wave region identifications.
|
||||
*/
|
||||
RAIL_ENUM(RAIL_ZWAVE_RegionId_t) {
|
||||
/** Unknown/Invalid. */
|
||||
RAIL_ZWAVE_REGIONID_UNKNOWN = 0,
|
||||
/** European Union. */
|
||||
RAIL_ZWAVE_REGIONID_EU = 1,
|
||||
/** United States. */
|
||||
RAIL_ZWAVE_REGIONID_US = 2,
|
||||
/** Australia/New Zealand. */
|
||||
RAIL_ZWAVE_REGIONID_ANZ = 3,
|
||||
/** Hong Kong. */
|
||||
RAIL_ZWAVE_REGIONID_HK = 4,
|
||||
/** Malaysia. */
|
||||
RAIL_ZWAVE_REGIONID_MY = 5,
|
||||
/** India. */
|
||||
RAIL_ZWAVE_REGIONID_IN = 6,
|
||||
/** Japan. */
|
||||
RAIL_ZWAVE_REGIONID_JP = 7,
|
||||
/** Russian Federation. */
|
||||
RAIL_ZWAVE_REGIONID_RU = 8,
|
||||
/** Israel. */
|
||||
RAIL_ZWAVE_REGIONID_IL = 9,
|
||||
/** Korea. */
|
||||
RAIL_ZWAVE_REGIONID_KR = 10,
|
||||
/** China. */
|
||||
RAIL_ZWAVE_REGIONID_CN = 11,
|
||||
/** United States, with first long range PHY. */
|
||||
RAIL_ZWAVE_REGIONID_US_LR1 = 12,
|
||||
/** United States, with second long range PHY. */
|
||||
RAIL_ZWAVE_REGIONID_US_LR2 = 13,
|
||||
/** United States, with third long range PHY. */
|
||||
RAIL_ZWAVE_REGIONID_US_LR3 = 14,
|
||||
/** @deprecated Backwards compatible name. */
|
||||
RAIL_ZWAVE_REGIONID_US_LR_END_DEVICE = RAIL_ZWAVE_REGIONID_US_LR3,
|
||||
/** European Union, with first long range PHY. */
|
||||
RAIL_ZWAVE_REGIONID_EU_LR1 = 15,
|
||||
/** European Union, with second long range PHY. */
|
||||
RAIL_ZWAVE_REGIONID_EU_LR2 = 16,
|
||||
/** European Union, with third long range PHY. */
|
||||
RAIL_ZWAVE_REGIONID_EU_LR3 = 17,
|
||||
/** @deprecated Backwards compatible name. */
|
||||
RAIL_ZWAVE_REGIONID_EU_LR_END_DEVICE = RAIL_ZWAVE_REGIONID_EU_LR3,
|
||||
/** Count of known regions. Must be last. */
|
||||
RAIL_ZWAVE_REGIONID_COUNT
|
||||
};
|
||||
|
||||
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
||||
// Self-referencing defines minimize compiler complaints when using RAIL_ENUM
|
||||
#define RAIL_ZWAVE_REGIONID_UNKNOWN ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_UNKNOWN)
|
||||
#define RAIL_ZWAVE_REGIONID_EU ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_EU)
|
||||
#define RAIL_ZWAVE_REGIONID_US ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_US)
|
||||
#define RAIL_ZWAVE_REGIONID_ANZ ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_ANZ)
|
||||
#define RAIL_ZWAVE_REGIONID_HK ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_HK)
|
||||
#define RAIL_ZWAVE_REGIONID_MY ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_MY)
|
||||
#define RAIL_ZWAVE_REGIONID_IN ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_IN)
|
||||
#define RAIL_ZWAVE_REGIONID_JP ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_JP)
|
||||
#define RAIL_ZWAVE_REGIONID_RU ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_RU)
|
||||
#define RAIL_ZWAVE_REGIONID_IL ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_IL)
|
||||
#define RAIL_ZWAVE_REGIONID_KR ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_KR)
|
||||
#define RAIL_ZWAVE_REGIONID_CN ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_CN)
|
||||
#define RAIL_ZWAVE_REGIONID_US_LR1 ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_US_LR1)
|
||||
#define RAIL_ZWAVE_REGIONID_US_LR2 ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_US_LR2)
|
||||
#define RAIL_ZWAVE_REGIONID_US_LR3 ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_US_LR3)
|
||||
#define RAIL_ZWAVE_REGIONID_US_LR_END_DEVICE ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_US_LR_END_DEVICE)
|
||||
#define RAIL_ZWAVE_REGIONID_EU_LR1 ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_EU_LR1)
|
||||
#define RAIL_ZWAVE_REGIONID_EU_LR2 ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_EU_LR2)
|
||||
#define RAIL_ZWAVE_REGIONID_EU_LR3 ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_EU_LR3)
|
||||
#define RAIL_ZWAVE_REGIONID_EU_LR_END_DEVICE ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_EU_LR_END_DEVICE)
|
||||
#define RAIL_ZWAVE_REGIONID_COUNT ((RAIL_ZWAVE_RegionId_t) RAIL_ZWAVE_REGIONID_COUNT)
|
||||
#endif //DOXYGEN_SHOULD_SKIP_THIS
|
||||
|
||||
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
||||
// Largest Ack timeout period based on
|
||||
// aPhyTurnaroundTimeRxTx (1 ms max)+ (aMacTransferAckTimeTX (168 bits)* (1/data rate))
|
||||
// For slowest Data Rate R1 (19.6 kbit/s)
|
||||
#define RAIL_ZWAVE_MAX_ACK_TIMEOUT_US (9600U)
|
||||
|
||||
// Defines for Transition timing
|
||||
#define RAIL_ZWAVE_TIME_IDLE_TO_RX_US (100U)
|
||||
#define RAIL_ZWAVE_TIME_TX_TO_RX_US (0U)
|
||||
#define RAIL_ZWAVE_TIME_IDLE_TO_TX_US (0U)
|
||||
#define RAIL_ZWAVE_TIME_RX_TO_TX_US (1000U)
|
||||
#endif //DOXYGEN_SHOULD_SKIP_THIS
|
||||
|
||||
/**
|
||||
* Invalid beam TX power value returned when \ref RAIL_ZWAVE_GetLrBeamTxPower()
|
||||
* is called after receiving a regular non-long-range beam.
|
||||
*/
|
||||
#define RAIL_ZWAVE_LR_BEAM_TX_POWER_INVALID (0xFFU)
|
||||
|
||||
/**
|
||||
* @struct RAIL_ZWAVE_LrAckData_t
|
||||
* @brief Configuration structure for Z-Wave Long Range Ack.
|
||||
*/
|
||||
typedef struct RAIL_ZWAVE_LrAckData {
|
||||
/// Radio noise level measured on the channel the frame is transmitted on.
|
||||
int8_t noiseFloorDbm;
|
||||
/// Transmit power used to transmit the ongoing Z-Wave Long Range Ack.
|
||||
int8_t txPowerDbm;
|
||||
/// Signal strength measured while receiving the Z-Wave Long Range frame.
|
||||
int8_t receiveRssiDbm;
|
||||
} RAIL_ZWAVE_LrAckData_t;
|
||||
|
||||
/**
|
||||
* @struct RAIL_ZWAVE_BeamRxConfig_t
|
||||
* @brief Configuration structure for Z-Wave beam detection.
|
||||
*
|
||||
* @warning This structure should not be used without direct instruction
|
||||
* by Silicon Labs. Appropriate defaults for this are built into
|
||||
* the RAIL library.
|
||||
*/
|
||||
typedef struct RAIL_ZWAVE_BeamRxConfig {
|
||||
/// Channel hopping pattern to use for beam detection.
|
||||
RAIL_RxChannelHoppingConfig_t channelHoppingConfig;
|
||||
/// Amount of time to spend trying to receive a beam once detected.
|
||||
/// 100kbps only
|
||||
RAIL_RxDutyCycleConfig_t receiveConfig_100;
|
||||
/// Amount of time to spend trying to receive a beam once detected.
|
||||
/// 40kbps only
|
||||
RAIL_RxDutyCycleConfig_t receiveConfig_40;
|
||||
} RAIL_ZWAVE_BeamRxConfig_t;
|
||||
|
||||
/**
|
||||
* Number of channels in each of Z-Wave's region-based PHYs.
|
||||
*/
|
||||
#define RAIL_NUM_ZWAVE_CHANNELS (4U)
|
||||
|
||||
/**
|
||||
* @struct RAIL_ZWAVE_RegionConfig_t
|
||||
* @brief Each Z-Wave region supports 3 channels.
|
||||
*/
|
||||
typedef struct RAIL_ZWAVE_RegionConfig {
|
||||
/** Channel frequency in hertz. */
|
||||
uint32_t frequency[RAIL_NUM_ZWAVE_CHANNELS];
|
||||
/** The maximum power allowed on the channel, in dBm. */
|
||||
RAIL_TxPower_t maxPower[RAIL_NUM_ZWAVE_CHANNELS];
|
||||
/** Channel baud rate index. */
|
||||
RAIL_ZWAVE_Baud_t baudRate[RAIL_NUM_ZWAVE_CHANNELS];
|
||||
/** Identification number for the region. */
|
||||
RAIL_ZWAVE_RegionId_t regionId;
|
||||
/** Encapsulates region-specific options. */
|
||||
RAIL_ZWAVE_RegionOptions_t regionSpecific;
|
||||
} RAIL_ZWAVE_RegionConfig_t;
|
||||
|
||||
/**
|
||||
* @struct RAIL_ZWAVE_IrcalVal_t
|
||||
* @brief Structure for Z-Wave Image Rejection Calibration.
|
||||
*
|
||||
* @note Index 0 will hold the low side image rejection calibration value (channel 0),
|
||||
* while index 1 will hold the high side image rejection value (channel 1).
|
||||
*/
|
||||
typedef struct RAIL_ZWAVE_IrcalVal {
|
||||
/** Low side and high side image rejection values. */
|
||||
RAIL_IrCalValues_t imageRejection[2];
|
||||
} RAIL_ZWAVE_IrcalVal_t;
|
||||
|
||||
/**
|
||||
* @typedef RAIL_RxChannelHoppingParameters_t
|
||||
* @brief Rx channel hopping on-channel time for all Z-Wave channels in a region
|
||||
*/
|
||||
typedef RAIL_RxChannelHoppingParameter_t RAIL_RxChannelHoppingParameters_t[RAIL_NUM_ZWAVE_CHANNELS];
|
||||
|
||||
/**
|
||||
* Switch the Z-Wave region.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in] regionCfg A pointer to a Z-Wave channel configuration for the selected region.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @note Setting a new Z-Wave Region will default any Low Power values to
|
||||
* Normal Power values for the region.
|
||||
* Z-Wave Region configuration must always be followed by a Low Power setup
|
||||
* in case one desires to have the Low Power Acking functionality.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_ConfigRegion(RAIL_Handle_t railHandle,
|
||||
const RAIL_ZWAVE_RegionConfig_t *regionCfg);
|
||||
|
||||
/**
|
||||
* Perform image rejection calibration on all valid channels of a
|
||||
* Z-Wave region.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in,out] pIrCalVals An application-provided pointer of
|
||||
* type \ref RAIL_ZWAVE_IrcalVal_t. This is populated with image rejection
|
||||
* calibration values, if not NULL or initialized with
|
||||
* \ref RAIL_CAL_INVALID_VALUE or if forceIrcal is true.
|
||||
* @param[in] forceIrcal If true, will always perform image rejection calibration
|
||||
* and not use previously cached values.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @note This function also calibrates for beam detection and should be
|
||||
* called before \ref RAIL_ZWAVE_ReceiveBeam() and after the Z-Wave region
|
||||
* has been configured via \ref RAIL_ZWAVE_ConfigRegion().
|
||||
* Channel hopping must be disabled otherwise this function will return
|
||||
* \ref RAIL_STATUS_INVALID_CALL.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_PerformIrcal(RAIL_Handle_t railHandle,
|
||||
RAIL_ZWAVE_IrcalVal_t *pIrCalVals,
|
||||
bool forceIrcal);
|
||||
|
||||
/**
|
||||
* Initialize RAIL for Z-Wave features.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in] config A pointer to a Z-Wave configuration structure.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* This function is the entry point for working with Z-Wave within
|
||||
* RAIL. It sets up relevant hardware acceleration for Z-Wave-specific
|
||||
* features, such as Home Id filtering and beam packets (as
|
||||
* specified in the configuration) and allows users to select the
|
||||
* relevant Z-Wave region-specific PHY via \ref RAIL_ZWAVE_ConfigRegion().
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_Init(RAIL_Handle_t railHandle,
|
||||
const RAIL_ZWAVE_Config_t *config);
|
||||
|
||||
/**
|
||||
* De-initialize Z-Wave hardware acceleration.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* Disables and resets all Z-Wave hardware acceleration features. This
|
||||
* function should only be called when the radio is idle.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_Deinit(RAIL_Handle_t railHandle);
|
||||
|
||||
/**
|
||||
* Return whether Z-Wave hardware acceleration is currently enabled.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @return true if Z-Wave hardware acceleration was enabled to start with
|
||||
* and false otherwise.
|
||||
*/
|
||||
bool RAIL_ZWAVE_IsEnabled(RAIL_Handle_t railHandle);
|
||||
|
||||
/**
|
||||
* Configure Z-Wave options.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in] mask A bitmask containing which options should be modified.
|
||||
* @param[in] options A bitmask containing desired configuration settings.
|
||||
* Bit positions for each option are found in the \ref RAIL_ZWAVE_Options_t.
|
||||
* @return Status code indicating success of the function call.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_ConfigOptions(RAIL_Handle_t railHandle,
|
||||
RAIL_ZWAVE_Options_t mask,
|
||||
RAIL_ZWAVE_Options_t options);
|
||||
|
||||
/**
|
||||
* Inform RAIL of the Z-Wave node's Node Id for receive filtering.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in] nodeId A Z-Wave Node Id.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @note Until this API is called, RAIL will assume the Node Id is
|
||||
* \ref RAIL_ZWAVE_NODE_ID_DEFAULT.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_SetNodeId(RAIL_Handle_t railHandle,
|
||||
RAIL_ZWAVE_NodeId_t nodeId);
|
||||
|
||||
/**
|
||||
* Inform RAIL of the Z-Wave node's Home Id and its hash for receive filtering.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in] homeId A Z-Wave Home Id.
|
||||
* @param[in] homeIdHash The hash of the Home Id expected in beam frames.
|
||||
* If this is \ref RAIL_ZWAVE_HOME_ID_HASH_DONT_CARE, beam frame detection
|
||||
* will not check the Home Id hash in a received beam frame at all, and
|
||||
* \ref RAIL_EVENT_ZWAVE_BEAM will trigger based solely on the Node Id
|
||||
* in the beam frame.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @note Until this API is called, RAIL will assume the Home Id is an
|
||||
* illegal one of \ref RAIL_ZWAVE_HOME_ID_DEFAULT, and its hash is \ref
|
||||
* RAIL_ZWAVE_HOME_ID_HASH_DONT_CARE.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_SetHomeId(RAIL_Handle_t railHandle,
|
||||
RAIL_ZWAVE_HomeId_t homeId,
|
||||
RAIL_ZWAVE_HomeIdHash_t homeIdHash);
|
||||
|
||||
/**
|
||||
* Get the Node Id of the most recently seen beam frame that triggered
|
||||
* \ref RAIL_EVENT_ZWAVE_BEAM.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[out] pNodeId A pointer to \ref RAIL_ZWAVE_NodeId_t to populate.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @note This is best called while handling the \ref RAIL_EVENT_ZWAVE_BEAM
|
||||
* event; if multiple beams are received only the most recent beam's NodeId
|
||||
* is provided.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_GetBeamNodeId(RAIL_Handle_t railHandle,
|
||||
RAIL_ZWAVE_NodeId_t *pNodeId);
|
||||
|
||||
/**
|
||||
* Get the Home Id hash of the most recently seen beam frame that triggered
|
||||
* \ref RAIL_EVENT_ZWAVE_BEAM.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[out] pBeamHomeIdHash A pointer to \ref RAIL_ZWAVE_HomeIdHash_t to populate.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @note This is best called while handling the \ref RAIL_EVENT_ZWAVE_BEAM
|
||||
* event; if multiple beams are received only the most recent beam's Home Id hash
|
||||
* is provided.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_GetBeamHomeIdHash(RAIL_Handle_t railHandle,
|
||||
RAIL_ZWAVE_HomeIdHash_t *pBeamHomeIdHash);
|
||||
|
||||
/**
|
||||
* Get the channel hopping index of the most recently seen beam frame that
|
||||
* triggered \ref RAIL_EVENT_ZWAVE_BEAM.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[out] pChannelIndex A pointer to a uint8_t to populate with
|
||||
* the channel hopping index. If channel-hopping was off at the time
|
||||
* the beam packet was received, \ref RAIL_CHANNEL_HOPPING_INVALID_INDEX
|
||||
* is provided.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @note This is best called while handling the \ref RAIL_EVENT_ZWAVE_BEAM
|
||||
* event; if multiple beams are received only the most recent beam's
|
||||
* channel hopping index is provided.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_GetBeamChannelIndex(RAIL_Handle_t railHandle,
|
||||
uint8_t *pChannelIndex);
|
||||
|
||||
/**
|
||||
* Get the TX power used by the transmitter of the most recently seen
|
||||
* long range beam frame that triggered \ref RAIL_EVENT_ZWAVE_BEAM.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[out] pLrBeamTxPower An application provided pointer to a uint8_t to
|
||||
* be populated with the TX power of the latest long range beam. This will
|
||||
* be set to \ref RAIL_ZWAVE_LR_BEAM_TX_POWER_INVALID if this API is called
|
||||
* after receiving a regular non-long-range beam.
|
||||
* @return Status code indicating success of the function call. This function
|
||||
* will return \ref RAIL_STATUS_INVALID_STATE if called after receiving a
|
||||
* regular (non-long-range) beam.
|
||||
*
|
||||
* @note This is best called while handling the \ref RAIL_EVENT_ZWAVE_BEAM
|
||||
* event; if multiple beams are received only the most recent long range
|
||||
* beam's TX power is provided.
|
||||
*
|
||||
* @note The following table shows long range beam TX power value to dBm
|
||||
* value mapping:
|
||||
*
|
||||
* <table>
|
||||
* <tr><th>Tx Power Value <th>Description
|
||||
* <tr><td>0 <td>-6 dBm
|
||||
* <tr><td>1 <td>-2 dBm
|
||||
* <tr><td>2 <td>+2 dBm
|
||||
* <tr><td>3 <td>+6 dBm
|
||||
* <tr><td>4 <td>+10 dBm
|
||||
* <tr><td>5 <td>+13 dBm
|
||||
* <tr><td>6 <td>+16 dBm
|
||||
* <tr><td>7 <td>+19 dBm
|
||||
* <tr><td>8 <td>+21 dBm
|
||||
* <tr><td>9 <td>+23 dBm
|
||||
* <tr><td>10 <td>+25 dBm
|
||||
* <tr><td>11 <td>+26 dBm
|
||||
* <tr><td>12 <td>+27 dBm
|
||||
* <tr><td>13 <td>+28 dBm
|
||||
* <tr><td>14 <td>+29 dBm
|
||||
* <tr><td>15 <td>+30 dBm
|
||||
* </table>
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_GetLrBeamTxPower(RAIL_Handle_t railHandle,
|
||||
uint8_t *pLrBeamTxPower);
|
||||
|
||||
/**
|
||||
* Get the RSSI of the received beam frame.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[out] pBeamRssi An application provided pointer to a int8_t to
|
||||
* be populated with the latest beam's RSSI, in dBm.
|
||||
* @return Status code indicating success of the function call. This function
|
||||
* will return \ref RAIL_STATUS_INVALID_STATE if called without ever
|
||||
* having received a beam.
|
||||
*
|
||||
* @note This is best called while handling the \ref RAIL_EVENT_ZWAVE_BEAM
|
||||
* event; if multiple beams are received only the most recent beam's
|
||||
* RSSI is provided.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_GetBeamRssi(RAIL_Handle_t railHandle,
|
||||
int8_t *pBeamRssi);
|
||||
|
||||
/**
|
||||
* Set the Raw Low Power settings.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in] powerLevel Desired low power raw level.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* Low Power settings are required during Ack transmissions when
|
||||
* the Low Power Bit is set. This setting is only valid for one
|
||||
* subsequent transmission, after which all transmissions will be
|
||||
* at the nominal power setting, until re-invoked.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_SetTxLowPower(RAIL_Handle_t railHandle,
|
||||
uint8_t powerLevel);
|
||||
|
||||
/**
|
||||
* Set the Low Power settings in deci-dBm.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in] powerLevel Desired low power level deci-dBm.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* Low Power settings are required during Ack transmissions when
|
||||
* the Low Power Bit is set. This setting is only valid for one
|
||||
* subsequent transmission, after which all transmissions will be
|
||||
* at the nominal power setting, until re-invoked.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_SetTxLowPowerDbm(RAIL_Handle_t railHandle,
|
||||
RAIL_TxPower_t powerLevel);
|
||||
|
||||
/**
|
||||
* Get the TX low power in raw units (see \ref rail_chip_specific.h for
|
||||
* value ranges).
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @return The chip-specific \ref RAIL_TxPowerLevel_t raw value of the low
|
||||
* transmit power.
|
||||
*
|
||||
* This API returns the low raw power value that was set by
|
||||
* \ref RAIL_ZWAVE_SetTxLowPower().
|
||||
*
|
||||
* Calling this function before configuring the Low Power PA
|
||||
* (i.e., before a successful
|
||||
* call to \ref RAIL_ZWAVE_SetTxLowPowerDbm() or \ref RAIL_ZWAVE_SetTxLowPower())
|
||||
* will return a low power value that is the same as the nominal power.
|
||||
* Also, calling this function before configuring the PA
|
||||
* (i.e., before a successful call to \ref RAIL_ConfigTxPower()) will return
|
||||
* \ref RAIL_TX_POWER_LEVEL_INVALID.
|
||||
*/
|
||||
RAIL_TxPowerLevel_t RAIL_ZWAVE_GetTxLowPower(RAIL_Handle_t railHandle);
|
||||
|
||||
/**
|
||||
* Get the TX low power in terms of deci-dBm instead of raw power level.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @return The chip-specific \ref RAIL_TxPower_t value of the low
|
||||
* transmit power in deci-dBm.
|
||||
*/
|
||||
RAIL_TxPower_t RAIL_ZWAVE_GetTxLowPowerDbm(RAIL_Handle_t railHandle);
|
||||
|
||||
/**
|
||||
* Implement beam detection and reception algorithms.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[out] beamDetectIndex A pointer to an indicator of whether or not a beam was detected
|
||||
* at all, regardless of if it was received, generally for use only by instruction
|
||||
* from Silicon Labs. Can be NULL.
|
||||
* @param[in] schedulerInfo A pointer to information to allow the radio scheduler to place
|
||||
* this operation appropriately. This is only used in multiprotocol version of
|
||||
* RAIL and may be set to NULL in all other versions.
|
||||
* Note that Z-Wave currently does not support multiprotocol, so this
|
||||
* scheduler info exists to future proof the API for when it does.
|
||||
* @return Status code indicating success of the function call.
|
||||
* Reasons for failure include an un-idled radio or a non-Japan non-Korea
|
||||
* region configured before calling this function.
|
||||
*
|
||||
* This function takes care of all configuration and radio setup to
|
||||
* detect and receive beams in the current Z-Wave region.
|
||||
* If a beam is detected, RAIL will provide
|
||||
* the usual \ref RAIL_EVENT_ZWAVE_BEAM event during which time users can
|
||||
* process the beam as expected. However, normal packets may also be
|
||||
* received during this time (also triggering \ref RAIL_EVENTS_RX_COMPLETION
|
||||
* events), in which case, this API may need to be re-called to receive
|
||||
* a beam. Users should also listen for
|
||||
* \ref RAIL_EVENT_RX_CHANNEL_HOPPING_COMPLETE, which will indicate
|
||||
* that no beam is heard. At that point, the radio will be automatically idled.
|
||||
* Until one of these events is received, users should not try to
|
||||
* reconfigure radio settings or start another radio operation. If an application
|
||||
* needs to do some other operation or configuration, it must first call
|
||||
* \ref RAIL_Idle() and wait for the radio to idle.
|
||||
*
|
||||
* @note: The radio must be idle before calling this function.
|
||||
*
|
||||
* @note: \ref RAIL_ConfigRxChannelHopping() must have been called successfully
|
||||
* in Z-Wave before this function is called to provide a valid memory buffer
|
||||
* for internal use (see \ref RAIL_RxChannelHoppingConfig_t::buffer).
|
||||
*
|
||||
* @note: This function alters radio functionality substantially. After calling
|
||||
* it, the user should call \ref RAIL_ZWAVE_ConfigRegion(),
|
||||
* \ref RAIL_ConfigRxChannelHopping(), \ref RAIL_EnableRxChannelHopping(),
|
||||
* and \ref RAIL_SetRxTransitions() to reset these parameters to whatever
|
||||
* behaviors were desired before calling this function. Additionally,
|
||||
* this function will idle the radio upon on exit.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_ReceiveBeam(RAIL_Handle_t railHandle,
|
||||
uint8_t *beamDetectIndex,
|
||||
const RAIL_SchedulerInfo_t *schedulerInfo);
|
||||
|
||||
/**
|
||||
* Configure the receive algorithm used in \ref RAIL_ZWAVE_ReceiveBeam().
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in] config A pointer to a configuration for the beam detection algorithm.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @warning This function should not be used without direct instruction by Silicon Labs.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_ConfigBeamRx(RAIL_Handle_t railHandle,
|
||||
RAIL_ZWAVE_BeamRxConfig_t *config);
|
||||
|
||||
/**
|
||||
* Set the default RX beam configuration.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @note This function resets any changes made to the beam configuration via
|
||||
* \ref RAIL_ZWAVE_ConfigBeamRx() and the default beam configuration will be in effect
|
||||
* on subsequent call(s) to \ref RAIL_ZWAVE_ReceiveBeam().
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_SetDefaultRxBeamConfig(RAIL_Handle_t railHandle);
|
||||
|
||||
/**
|
||||
* Get the current RX beam configuration.
|
||||
*
|
||||
* @param[out] pConfig A pointer to \ref RAIL_ZWAVE_BeamRxConfig_t to be
|
||||
* populated with the current beam configuration.
|
||||
* @return Status code indicating success of the function call.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_GetRxBeamConfig(RAIL_ZWAVE_BeamRxConfig_t *pConfig);
|
||||
|
||||
/**
|
||||
* Configure the channel hop timings for use in Z-Wave RX channel hop configuration.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in,out] config A pointer to a configuration for Z-Wave RX channel hopping.
|
||||
* This structure must be allocated in application global read-write memory.
|
||||
* RAIL will populate fields within or referenced by this structure during its
|
||||
* operation. Be sure to allocate \ref RAIL_RxChannelHoppingConfigEntry_t
|
||||
* entries[] for \ref RAIL_NUM_ZWAVE_CHANNELS. Be sure to set \ref
|
||||
* RAIL_RxChannelHoppingConfig_t::numberOfChannels to the desired number of
|
||||
* channels.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* @warning This function should not be used without direct instruction by Silicon Labs.
|
||||
*
|
||||
* @note: This API must be called before \ref RAIL_EnableRxChannelHopping(). This
|
||||
* API must never be called while the radio is on with RX Duty Cycle or Channel
|
||||
* Hopping enabled.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_ConfigRxChannelHopping(RAIL_Handle_t railHandle,
|
||||
RAIL_RxChannelHoppingConfig_t *config);
|
||||
|
||||
/**
|
||||
* Get the Z-Wave region.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @return The \ref RAIL_ZWAVE_RegionId_t value.
|
||||
*
|
||||
* @note \ref RAIL_ZWAVE_ConfigRegion() must have been called successfully
|
||||
* before this function is called. Otherwise, \ref RAIL_ZWAVE_REGIONID_UNKNOWN
|
||||
* is returned.
|
||||
*/
|
||||
RAIL_ZWAVE_RegionId_t RAIL_ZWAVE_GetRegion(RAIL_Handle_t railHandle);
|
||||
|
||||
/**
|
||||
* Write the Auto-Ack FIFO for the next outgoing Z-Wave Long Range Ack.
|
||||
*
|
||||
* @param[in] railHandle A RAIL instance handle.
|
||||
* @param[in] pLrAckData An application provided pointer to a const
|
||||
* \ref RAIL_ZWAVE_LrAckData_t to populate the noise floor, TX power and receive
|
||||
* rssi bytes of the outgoing Z-Wave Long Range Ack packet.
|
||||
* @return Status code indicating success of the function call.
|
||||
*
|
||||
* This function sets the Auto-Ack data to use in acknowledging the frame
|
||||
* being received. It must only be called while processing the \ref
|
||||
* RAIL_EVENT_ZWAVE_LR_ACK_REQUEST_COMMAND.
|
||||
* This will return \ref RAIL_STATUS_INVALID_STATE if it is too late to
|
||||
* write the outgoing Ack. When successful, the ackData will
|
||||
* only be sent once. Subsequent packets needing an Z-Wave Long Range Ack will
|
||||
* each need to call this function to write the Ack information.
|
||||
*/
|
||||
RAIL_Status_t RAIL_ZWAVE_SetLrAckData(RAIL_Handle_t railHandle,
|
||||
const RAIL_ZWAVE_LrAckData_t *pLrAckData);
|
||||
|
||||
/** EU-European Union */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_EU;
|
||||
|
||||
/** US-United States */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_US;
|
||||
|
||||
/** ANZ-Australia/New Zealand */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_ANZ;
|
||||
|
||||
/** HK-Hong Kong */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_HK;
|
||||
|
||||
/** MY-Malaysia */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_MY;
|
||||
|
||||
/** IN-India */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_IN;
|
||||
|
||||
/** JP-Japan */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_JP;
|
||||
|
||||
/** JP-Japan Energy-Detect */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_JPED;
|
||||
|
||||
/** RU-Russia */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_RU;
|
||||
|
||||
/** IL-Israel */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_IL;
|
||||
|
||||
/** KR-Korea */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_KR;
|
||||
|
||||
/** KR-Korea Energy-Detect */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_KRED;
|
||||
|
||||
/** CN-China */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_CN;
|
||||
|
||||
/** US-Long Range 1 */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_US_LR1;
|
||||
|
||||
/** US-Long Range 2 */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_US_LR2;
|
||||
|
||||
/** US-Long Range 3 */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_US_LR3;
|
||||
/** Backwards-compatible define */
|
||||
#define RAIL_ZWAVE_REGION_US_LR_END_DEVICE RAIL_ZWAVE_REGION_US_LR3
|
||||
|
||||
/** EU-Long Range 1 */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_EU_LR1;
|
||||
|
||||
/** EU-Long Range 2 */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_EU_LR2;
|
||||
|
||||
/** EU-Long Range 3 */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_EU_LR3;
|
||||
/** Backwards-compatible define */
|
||||
#define RAIL_ZWAVE_REGION_EU_LR_END_DEVICE RAIL_ZWAVE_REGION_EU_LR3
|
||||
|
||||
/** Invalid Region */
|
||||
extern const RAIL_ZWAVE_RegionConfig_t RAIL_ZWAVE_REGION_INVALID;
|
||||
|
||||
/** @} */ // end of Z_Wave
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif // __RAIL_ZWAVE_H__
|
||||
Reference in New Issue
Block a user