DeviceState

Struct DeviceState 

Source
pub struct DeviceState {
    pub device_info: DeviceInfo,
    pub device_data: DeviceData,
    pub model: Option<DeviceModel>,
    pub pins: Vec<PinData>,
    pub encoders: Vec<EncoderData>,
    pub pwm: PwmData,
    pub last_update: u64,
    pub status: ThreadStatus,
    pub error_message: Option<String>,
    pub custom_values: HashMap<String, String>,
}
Expand description

Device state that is shared between threads.

This struct contains all the state information for a device, including device information, pin data, encoder data, and PWM data.

Fields§

§device_info: DeviceInfo

Device information

§device_data: DeviceData

Device data

§model: Option<DeviceModel>

Device model

§pins: Vec<PinData>

Pin data

§encoders: Vec<EncoderData>

Encoder data

§pwm: PwmData

PWM data

§last_update: u64

Last update timestamp

§status: ThreadStatus

Thread status

§error_message: Option<String>

Error message if any

§custom_values: HashMap<String, String>

Custom state values

Implementations§

Source§

impl DeviceState

Source

pub fn new(device_info: DeviceInfo, device_data: DeviceData) -> Self

Create a new device state.

§Parameters
  • device_info - The device information.
  • device_data - The device data.
§Returns

A new device state.

Source

pub fn update_from_device(&mut self, device: &PoKeysDevice)

Update the state from a PoKeys device.

§Parameters
  • device - The PoKeys device to update from.
Source

pub fn get_digital_input(&self, pin: u32) -> Option<bool>

Get a digital input value.

§Parameters
  • pin - The pin number to read.
§Returns

The value of the digital input (true for high, false for low), or None if the pin is invalid.

Source

pub fn get_analog_input(&self, pin: u32) -> Option<u32>

Get an analog input value.

§Parameters
  • pin - The pin number to read.
§Returns

The value of the analog input (0-4095 for 12-bit ADC), or None if the pin is invalid.

Source

pub fn get_encoder_value(&self, encoder_index: u32) -> Option<i32>

Get an encoder value.

§Parameters
  • encoder_index - The encoder index to read.
§Returns

The value of the encoder, or None if the encoder index is invalid.

Source

pub fn get_pwm_duty_cycle(&self, channel: usize) -> Option<u32>

Get a PWM duty cycle.

§Parameters
  • channel - The PWM channel to read.
§Returns

The duty cycle of the PWM channel (0-4095 for 12-bit PWM), or None if the channel is invalid.

Trait Implementations§

Source§

impl Clone for DeviceState

Source§

fn clone(&self) -> DeviceState

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DeviceState

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DeviceState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for DeviceState

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,