Myriota Flex SDK 2.5.0
Loading...
Searching...
No Matches
Power Out Control

Configure and control the FlexSense Power Out interface. More...

Enumerations

enum  FLEX_PowerOut { FLEX_POWER_OUT_24V , FLEX_POWER_OUT_12V , FLEX_POWER_OUT_5V }
 Power Output Voltage Options. More...
 

Functions

int FLEX_PowerOutInit (const FLEX_PowerOut Voltage)
 
int FLEX_PowerOutDeinit (void)
 

Detailed Description

Configure and control the FlexSense Power Out interface.

The FlexSense Power Out can supply DC power at 5V, 12V or 24V. The maximum Current supported on this interface is 25mA

Warning
To maximise the battery life of your FlexSense, we recommend initialising and de-initialising the Power Out interface each time the job using it is called. This will reduce the idle power usage of your FlexSense.

Enumeration Type Documentation

◆ FLEX_PowerOut

Power Output Voltage Options.

Enumerator
FLEX_POWER_OUT_24V 

set output voltage to 24V

FLEX_POWER_OUT_12V 

set output voltage to 12V

FLEX_POWER_OUT_5V 

set output voltage to 5V

Function Documentation

◆ FLEX_PowerOutInit()

int FLEX_PowerOutInit ( const FLEX_PowerOut Voltage)

Enable and sets the Output Voltage.

Note
De-initialise the Power Output before a job is completed to preserve device power.
Parameters
[in]Voltagethe required output voltage selected from FLEX_PowerOut.
Returns
FLEX_SUCCESS (0) if succeeded and < 0 if failed.
Return values
-FLEX_ERROR_EALREADYalready initialised
-FLEX_ERROR_IO_EXPANDERfailed to initialise or configure expander device
-FLEX_ERROR_EOPNOTSUPPtried to set invalid power out value
-FLEX_ERROR_PWMfailed to setup or configure pwm device

◆ FLEX_PowerOutDeinit()

int FLEX_PowerOutDeinit ( void )

Disables the Output Voltage

Note
De-initialise the Power Output before a job is completed to preserve device power.
Returns
FLEX_SUCCESS (0) if succeeded and < 0 if failed.
Return values
-FLEX_ERROR_IO_EXPANDERfailed to configure expander device