Struct ControlInterface

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

Fields

host: String

Implementations

impl ControlInterface

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

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

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

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

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.

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.

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

Creates a ControlInterface by a DeviceIdentifier.

pub fn get_hw_address(&self) -> String

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<()>

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

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

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

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

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.

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.

pub fn get_device_info(&self) -> &DeviceInfoResponse

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.

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

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

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

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

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

Helper method to set the device mode.

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.

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

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

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

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

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

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

Fetches the LED layout from the device.

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

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

Clears all uploaded movies from the device.

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

impl Clone for ControlInterface

fn clone(&self) -> ControlInterface

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ControlInterface

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

Formats the value using the given formatter.

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.

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ControlInterface

Sort in that order:

1. device_info
2. host
3. hw_address

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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