phoenix6.unmanaged

Module Contents

Functions

feed_enable(timeout_seconds)

Feeds the enable signal with a timeout specified in seconds.

get_enable_state(→ bool)

set_transmit_enable(enable)

Sets whether to transmit the enable frame.

get_transmit_enable(→ bool)

Gets whether the enable frame is being transmitted.

get_phoenix_version(→ int)

get_api_compliancy(→ int)

Gets this API's compliancy version.

load_phoenix()

Load and start the Phoenix background tasks.

set_phoenix_diagnostics_start_time(start_time_seconds)

Sets the duration of the delay before starting the Phoenix diagnostics server.
phoenix6.unmanaged.feed_enable(timeout_seconds: phoenix6.units.second)

Feeds the enable signal with a timeout specified in seconds. This function does nothing on a Systemcore during FRC use.

A timeout of 0 disables actuators.

Parameters:

timeout_seconds (second) – Time to remain enabled in seconds

phoenix6.unmanaged.get_enable_state() → bool
Returns:

True if non-FRC enabled

Return type:

bool

phoenix6.unmanaged.set_transmit_enable(enable: bool)

Sets whether to transmit the enable frame. This function does nothing on a Systemcore during FRC use.

Parameters:

enable (bool) – True to transmit the enable frame

phoenix6.unmanaged.get_transmit_enable() → bool

Gets whether the enable frame is being transmitted. This function returns True on a Systemcore during FRC use.

Returns:

True if the enable frame is being transmitted

Return type:

bool

phoenix6.unmanaged.get_phoenix_version() → int
Returns:

The current version of Phoenix

Return type:

int

phoenix6.unmanaged.get_api_compliancy() → int

Gets this API’s compliancy version.

This is purely used to check the compliancy of API against firmware, and report if there is a mismatch to the user.

Returns:

The current API compliancy

Return type:

int

phoenix6.unmanaged.load_phoenix()

Load and start the Phoenix background tasks.

This can be useful if you need the Enable/Disable functionality for CAN devices but aren’t using any of the CAN device classes.

This function does NOT need to be called if you are using any of the Phoenix CAN device classes.

phoenix6.unmanaged.set_phoenix_diagnostics_start_time(start_time_seconds: phoenix6.units.second)

Sets the duration of the delay before starting the Phoenix diagnostics server.

Parameters:

start_time_seconds (second) – The delay (in seconds) before starting the server. A value of 0 will start the server immediately. A negative value will signal the server to shutdown or never start.