[−][src]Struct clyde_3g_eps_api::Eps
EPS structure containing low level connection and functionality required for commanding and requesting telemetry from EPS device.
Methods
impl Eps[src]
impl Epspub fn new(connection: Connection) -> Self[src]
pub fn new(connection: Connection) -> SelfConstructor
Creates new instance of Eps structure.
Arguments
connection - A Connection used as low-level connection to EPS hardware
pub fn get_board_status(&self) -> EpsResult<BoardStatus>[src]
pub fn get_board_status(&self) -> EpsResult<BoardStatus>Get Board Status
The status bytes are designed to supply operational data about the I2C Node.
pub fn get_checksum(&self) -> EpsResult<Checksum>[src]
pub fn get_checksum(&self) -> EpsResult<Checksum>Get Checksum
This command instructs the node to self-inspect its ROM contents in order to generate a checksum. The value retrieved can be used to determine whether the contents of the ROM have changed during the operation of the device.
pub fn get_version_info(&self) -> EpsResult<VersionInfo>[src]
pub fn get_version_info(&self) -> EpsResult<VersionInfo>Get Version
The version number of the firmware will be returned on this command. The revision number returns the current revision of the firmware that is present on the board. The firmware number returns the current firmware on the board.
pub fn get_last_error(&self) -> EpsResult<LastError>[src]
pub fn get_last_error(&self) -> EpsResult<LastError>Get Last Error
If an error has been generated after attempting to execute a user's command, this command can be used to retrieve details about the error.
pub fn manual_reset(&self) -> EpsResult<()>[src]
pub fn manual_reset(&self) -> EpsResult<()>Manual Reset
If required the user can reset the TTC node using this command. When issued, the board will reset within 1 second. This command will result in the board being brought up in its defined initial condition. Resetting the board in this fashion will increment the Manual Reset Counter.
pub fn reset_comms_watchdog(&self) -> EpsResult<()>[src]
pub fn reset_comms_watchdog(&self) -> EpsResult<()>Reset Communications Watchdog
Any valid command will reset the communications watchdog timer. If the user does not require any telemetry from the board, this command can be sent to reset the communications watchdog.
pub fn get_motherboard_telemetry(&self, telem_type: Type) -> EpsResult<f64>[src]
pub fn get_motherboard_telemetry(&self, telem_type: Type) -> EpsResult<f64>Get Motherboard Telemetry
This command is used to request telemetry items from the motherboard's telemetry node.
Arguments
telem_type - Variant of MotherboardTelemetry::Type to request
pub fn get_daughterboard_telemetry(&self, telem_type: Type) -> EpsResult<f64>[src]
pub fn get_daughterboard_telemetry(&self, telem_type: Type) -> EpsResult<f64>Get Daughterboard Telemetry
This command is used to request telemetry items from the daughterboard's telemetry node.
Arguments
telem_type - Variant of DaughterboardTelemetry::Type to request
pub fn get_reset_telemetry(&self, telem_type: Type) -> EpsResult<Data>[src]
pub fn get_reset_telemetry(&self, telem_type: Type) -> EpsResult<Data>Get Reset Telemetry
This command is used to request telemetry items regarding various reset conditions on both the motherboard and daughterboard.
Arguments
telem_type - Variant of ResetTelemetry::Type to request
pub fn set_comms_watchdog_period(&self, period: u8) -> EpsResult<()>[src]
pub fn set_comms_watchdog_period(&self, period: u8) -> EpsResult<()>Set Communications Watchdog Period
The Communications Watchdog by default has a value of 4 minutes set as its timeout period. If 4 minutes pass without a command being received then the device will reboot into its pre-defined initial state. This value of 4 minutes can be changed using the Set Communications Watchdog Period command, 0x21. The data byte specifies the number of minutes the communications watchdog will wait before timing out.
Arguments
period - Watchdog period to set in minutes
pub fn get_comms_watchdog_period(&self) -> EpsResult<u8>[src]
pub fn get_comms_watchdog_period(&self) -> EpsResult<u8>Get Communications Watchdog Period
This command provides the user with the current communications watchdog timeout that has been set. The returned value is indicated in minutes.
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into for T where
U: From<T>, [src]
impl<T, U> Into for T where
U: From<T>, impl<T> From for T[src]
impl<T> From for Timpl<T, U> TryFrom for T where
T: From<U>, [src]
impl<T, U> TryFrom for T where
T: From<U>, type Error = !
try_from)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>impl<T> Borrow for T where
T: ?Sized, [src]
impl<T> Borrow for T where
T: ?Sized, impl<T> Any for T where
T: 'static + ?Sized, [src]
impl<T> Any for T where
T: 'static + ?Sized, fn get_type_id(&self) -> TypeId[src]
fn get_type_id(&self) -> TypeIdimpl<T, U> TryInto for T where
U: TryFrom<T>, [src]
impl<T, U> TryInto for T where
U: TryFrom<T>, type Error = <U as TryFrom<T>>::Error
try_from)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>impl<T> BorrowMut for T where
T: ?Sized, [src]
impl<T> BorrowMut for T where
T: ?Sized, fn borrow_mut(&mut self) -> &mut T[src]
fn borrow_mut(&mut self) -> &mut T