Fork of my original MQTTGateway
General Private Functions
[SPIRIT_General]
Functions | |
void | SpiritGeneralBatteryLevel (SpiritFunctionalState xNewState) |
Enables or Disables the output of battery level detector. | |
void | SpiritGeneralSetBatteryLevel (BatteryLevel xBatteryLevel) |
Sets the battery level. | |
BatteryLevel | SpiritGeneralGetBatteryLevel (void) |
Returns the settled battery level. | |
void | SpiritGeneralBrownOut (SpiritFunctionalState xNewState) |
Enables or Disables the output of brown out detector. | |
void | SpiritGeneralHighPwr (SpiritFunctionalState xNewState) |
Sets High Power Mode. | |
void | SpiritGeneralSetExtRef (ModeExtRef xExtMode) |
Sets External Reference. | |
ModeExtRef | SpiritGeneralGetExtRef (void) |
Returns External Reference. | |
void | SpiritGeneralSetXoGm (GmConf xGm) |
Sets XO gm at startup. | |
GmConf | SpiritGeneralGetXoGm (void) |
Returns the configured XO gm at startup. | |
PacketType | SpiritGeneralGetPktType (void) |
Returns the settled packet format. | |
uint16_t | SpiritGeneralGetDevicePartNumber (void) |
Returns device part number. | |
uint8_t | SpiritGeneralGetSpiritVersion (void) |
Returns SPIRIT RF board version. |
Function Documentation
void SpiritGeneralBatteryLevel | ( | SpiritFunctionalState | xNewState ) |
Enables or Disables the output of battery level detector.
- Parameters:
-
xNewState new state for battery level detector. This parameter can be: S_ENABLE or S_DISABLE.
- Return values:
-
None
Definition at line 118 of file SPIRIT_General.c.
void SpiritGeneralBrownOut | ( | SpiritFunctionalState | xNewState ) |
Enables or Disables the output of brown out detector.
- Parameters:
-
xNewState new state for brown out detector. This parameter can be: S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 208 of file SPIRIT_General.c.
BatteryLevel SpiritGeneralGetBatteryLevel | ( | void | ) |
Returns the settled battery level.
- Parameters:
-
None.
- Return values:
-
BatteryLevel Settled battery level. This parameter can be a value of BatteryLevel.
Definition at line 189 of file SPIRIT_General.c.
uint16_t SpiritGeneralGetDevicePartNumber | ( | void | ) |
Returns device part number.
- Parameters:
-
None.
- Return values:
-
uint16_t Device part number.
Definition at line 411 of file SPIRIT_General.c.
ModeExtRef SpiritGeneralGetExtRef | ( | void | ) |
Returns External Reference.
- Parameters:
-
None.
- Return values:
-
ModeExtRef Settled external reference. This parameter can be: MODE_EXT_XO or MODE_EXT_XIN.
Definition at line 304 of file SPIRIT_General.c.
PacketType SpiritGeneralGetPktType | ( | void | ) |
Returns the settled packet format.
- Parameters:
-
None.
- Return values:
-
PacketType Settled packet type. This parameter can be a value of PacketType.
Definition at line 392 of file SPIRIT_General.c.
uint8_t SpiritGeneralGetSpiritVersion | ( | void | ) |
Returns SPIRIT RF board version.
- Parameters:
-
None.
- Return values:
-
SPIRIT RF board version: 0x30 is the only admitted value
Definition at line 427 of file SPIRIT_General.c.
GmConf SpiritGeneralGetXoGm | ( | void | ) |
Returns the configured XO gm at startup.
- Parameters:
-
None.
- Return values:
-
GmConf Settled XO gm. This parameter can be a value of GmConf.
Definition at line 374 of file SPIRIT_General.c.
void SpiritGeneralHighPwr | ( | SpiritFunctionalState | xNewState ) |
Sets High Power Mode.
- Parameters:
-
xNewState new state for High Power Mode. This parameter can be: S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 240 of file SPIRIT_General.c.
void SpiritGeneralSetBatteryLevel | ( | BatteryLevel | xBatteryLevel ) |
Sets the battery level.
- Parameters:
-
xBatteryLevel new state for battery level. This parameter can be a value of BatteryLevel.
- Return values:
-
None.
Definition at line 150 of file SPIRIT_General.c.
void SpiritGeneralSetExtRef | ( | ModeExtRef | xExtMode ) |
Sets External Reference.
- Parameters:
-
xExtMode new state for the external reference. This parameter can be: MODE_EXT_XO or MODE_EXT_XIN.
- Return values:
-
None.
Definition at line 272 of file SPIRIT_General.c.
void SpiritGeneralSetXoGm | ( | GmConf | xGm ) |
Sets XO gm at startup.
- Parameters:
-
xGm transconductance value of XO at startup. This parameter can be a value of GmConf.
- Return values:
-
None.
Definition at line 323 of file SPIRIT_General.c.
Generated on Tue Jul 12 2022 18:06:48 by 1.7.2