phoenix6.unmanaged¶
Module Contents¶
Functions¶
|
Feeds the enable signal with a timeout specified in seconds. |
|
Gets this API's compliancy version |
|
Gets this version of Phoenix |
|
|
|
Sets the duration of the delay before starting the Phoenix |
Calling this function will load and start the Phoenix background tasks. |
- 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 roboRIO during FRC use.
- Parameters:
timeout_seconds (second) – Time to remain enabled in seconds
- phoenix6.unmanaged.get_api_compliancy() int¶
Gets this API’s compliancy version
This is purely used to check compliancy of API against firmware, and if there is a mismatch to report to the user.
- Returns:
This API’s compliancy version
- Return type:
int
- phoenix6.unmanaged.get_phoenix_version() int¶
Gets this version of Phoenix
- Returns:
This version of Phoenix
- Return type:
int
- phoenix6.unmanaged.get_enable_state() bool¶
- Returns:
true if non-FRC enabled
- Return type:
bool
- 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 – Magnitude of 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. :type start_time_seconds: second
- phoenix6.unmanaged.load_phoenix()¶
Calling this function will 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.