Struct ControlInterface

Source
pub struct ControlInterface {
    pub host: String,
    /* private fields */
}

Fields§

§host: String

Implementations§

Source§

impl ControlInterface

Source

pub async fn new( host: &str, hw_address: &str, existing_auth_token: Option<String>, ) -> Result<Self>

Source

pub async fn reauthenticate(&mut self) -> bool

Source

pub fn with_auth_token(self, auth_token: String) -> Self

Updates the authentication token, after a device re-authenticated.

Source

pub fn new_mock_device_info_response( id: String, device_name: String, mac: String, number_of_led: usize, ) -> DeviceInfoResponse

Creates a mock / demo DeviceInfoResponse. A utility function for Self::new_mock_control_interface.

Source

pub fn new_mock_control_interface( host: String, hw_address: String, auth_token: String, device_info: DeviceInfoResponse, ) -> Self

Creates a mock / demo ControlInterface with a demo DeviceInfoResponse. A utility function Self::new_mock_device_info_response exists, to easily create a valid DeviceInfoResponse.

Source

pub async fn from_device_identifier( device_identifier: DeviceIdentifier, ) -> Result<Self>

Source

pub fn get_hw_address(&self) -> String

Source

pub async fn shine_leds( &self, time_between_glow_start: Duration, time_to_max_glow: Duration, time_to_fade: Duration, colors: HashSet<RGB>, frame_rate: f64, num_start_simultaneous: usize, ) -> Result<()>

Source

pub async fn show_solid_color(&self, rgb: RGB) -> Result<()>

Source

pub async fn show_real_time_stdin_stream( &self, format: RtStdinFormat, error_mode: RtStdinErrorMode, leds_per_frame: u16, min_frame_time: Duration, ) -> Result<()>

Source

pub async fn show_real_time_test_color_wheel( &self, step: f64, frame_rate: f64, ) -> Result<()>

Source

pub fn flatten_rgb_vec(rgb_vec: Vec<(u8, u8, u8)>) -> Vec<u8>

Source

pub async fn set_rt_frame_socket( &self, socket: &UdpSocket, frame: &[u8], version: HardwareVersion, ) -> Result<usize>

Set realtime frame with a provided socket.

§Return

Returns either the written bytes or an error.

Source

pub async fn show_rt_frame(&self, frame: &[u8]) -> Result<usize>

Ensures the mode is DeviceMode::RealTime, creates a UDP socket, connect it and send a frame to it. For a continuous animation, without constant socket recreation and rebinding, use Self::set_rt_frame_socket instead.

§Return

Returns either the written bytes or an error.

Source

pub fn get_device_info(&self) -> &DeviceInfoResponse

Source

pub async fn upload_movie<P: AsRef<Path>>( &self, path: P, led_profile: LedProfile, _fps: f64, force: bool, ) -> Result<u32>

Uploads a new movie to the device.

Source

pub async fn turn_on(&self) -> Result<VerifyResponse>

Turns on the device by setting it to the last known mode or a default mode.

Source

pub async fn turn_off(&self) -> Result<VerifyResponse>

Turns off the device and remembers the last non-real-time mode.

Source

pub async fn set_mode(&self, mode: DeviceMode) -> Result<VerifyResponse>

Helper method to set the device mode.

Source

pub async fn set_brightness(&self, brightness: i32) -> Result<()>

Helper method to set the device brightness.

§Arguments
  • brightness: The brightness value to set. Range is 0..100.
Source

pub async fn get_mode(&self) -> Result<DeviceMode>

Source

pub async fn get_brightness(&self) -> Result<BrightnessResponse>

Source

pub async fn get_timer(&self) -> Result<TimerResponse>

Source

pub async fn set_formatted_timer( &self, time_on_str: &str, time_off_str: &str, ) -> Result<()>

Source

pub async fn get_playlist(&self) -> Result<PlaylistResponse>

Source

pub async fn fetch_layout(&self) -> Result<LayoutResponse>

Fetches the LED layout from the device.

Source

pub async fn get_device_capacity(&self) -> Result<usize>

Source

pub async fn clear_movies(&self) -> Result<()>

Clears all uploaded movies from the device.

Source

pub fn to_movie( frames: Vec<Vec<(u8, u8, u8)>>, led_profile: LedProfile, ) -> Vec<u8>

Converts a vector of frames into a binary movie format. This function handles both RGB and RGBW LED profiles.

Trait Implementations§

Source§

impl Clone for ControlInterface

Source§

fn clone(&self) -> ControlInterface

Returns a copy 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 ControlInterface

Source§

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

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

impl PartialEq for ControlInterface

Compare everything, except the client, since this that is a utility, and not a device describing identifier. Also ignoring the token, since this changes on every new connection, while the device stays the same.

Source§

fn eq(&self, other: &ControlInterface) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for ControlInterface

Sort in that order:

  1. device_info
  2. host
  3. hw_address
Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
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, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. 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, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,