Struct RemoteIo

pub struct RemoteIo { /* private fields */ }

Implements the Firmata protocol within an IoProtocol.

Implementations

impl RemoteIo

pub fn new<P: Into<String>>(port: P) -> Self

impl RemoteIo

pub fn start_polling(&self)

Manually attaches the board value change listener. This is only used for input events. This should never be needed unless you manually detach() the sensor first for some reason and want it to start being reactive to events again.

pub fn stop_polling(&self)

Detaches the interval associated with the button. This means the button won’t react anymore to value changes.

Trait Implementations

impl Clone for RemoteIo

fn clone(&self) -> RemoteIo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoteIo

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

Formats the value using the given formatter.

impl Default for RemoteIo

fn default() -> Self

Returns the “default value” for a type.

impl Display for RemoteIo

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

Formats the value using the given formatter.

impl<T: IoTransport + 'static> From<T> for RemoteIo

fn from(transport: T) -> Self

Converts to this type from the input type.

impl IO for RemoteIo

fn get_io(&self) -> &Arc<RwLock<IoData>>

Returns a protected arc to the inner IoData.

fn is_connected(&self) -> bool

Checks if the communication is opened using the underlying protocol.

fn set_pin_mode(&mut self, pin: u8, mode: PinModeId) -> Result<(), Error>

Sets the mode of the specified pin.

fn digital_write(&mut self, pin: u8, level: bool) -> Result<(), Error>

Writes level to the digital pin.

fn analog_write(&mut self, pin: u8, level: u16) -> Result<(), Error>

Writes level to the analog pin.

fn digital_read(&mut self, _: u8) -> Result<bool, Error>

Reads the digital pin value.

fn analog_read(&mut self, _: u8) -> Result<u16, Error>

Reads the analog pin value.

fn servo_config(&mut self, pin: u8, pwm_range: Range<u16>) -> Result<(), Error>

Sends a SERVO_CONFIG command (0x70 - configure servo) https://github.com/firmata/protocol/blob/master/servos.md

fn i2c_config(&mut self, delay: u16) -> Result<(), Error>

Configures the delay in microseconds for I2C devices that require a delay between when the register is written to and the data in that register can be read.

fn i2c_read(&mut self, address: u8, size: u16) -> Result<(), Error>

Reads size bytes from I2C device at the specified address.

fn i2c_write(&mut self, address: u8, data: &[u16]) -> Result<(), Error>

Writes data to the I2C device at the specified address.

impl IoProtocol for RemoteIo

fn open(&mut self) -> Result<(), Error>

Opens the communication using the underlying protocol.

fn close(&mut self) -> Result<(), Error>

Gracefully shuts down the communication.

fn report_analog(&mut self, channel: u8, state: bool) -> Result<(), Error>

Sets the analog reporting state of the specified analog pin.

fn report_digital(&mut self, pin: u8, state: bool) -> Result<(), Error>

Sets the digital reporting state of the specified digital pin.

fn sampling_interval(&mut self, interval: u16) -> Result<(), Error>

Set the sampling interval (in ms).

fn get_name(&self) -> &'static str

Returns the protocol name.