Struct hc12_at::hc12::Hc12

pub struct Hc12<S, P, D, M> where
    S: Read<u8> + Write<u8>,
    P: OutputPin,
    D: DelayMs<u32>,  { /* fields omitted */ }

Hc12 resources: A serial port, an output pin, and a Delay.

Implementations

impl<S, P, D> Hc12<S, P, D, Normal> where
    S: Read<u8> + Write<u8>,
    P: OutputPin,
    D: DelayMs<u32>, 

Implementation for normal mode of Hc12

pub fn new(serial: S, set_pin: P, delay: D) -> Self

Construct an Hc12 in normal mode

pub fn release(self) -> (S, P, D)

Release the contained resources

pub fn write_buffer(&mut self, buffer: &[u8]) -> Result<(), Error<Error>>

Write entire buffer to serial port

pub fn read_buffer(&mut self, buffer: &mut [u8]) -> Result<(), Error<Error>>

Read entire buffer from serial port

pub fn into_configuration_mode(
    self
) -> Result<Hc12<S, P, D, Configuration>, Hc12<S, P, D, Normal>>

Move Hc12 in normal mode to Hc12 in config mode

impl<S, P, D> Hc12<S, P, D, Configuration> where
    S: Read<u8> + Write<u8>,
    P: OutputPin,
    D: DelayMs<u32>, 

Implementation for Hc12 in config mode.

pub fn into_normal_mode(
    self
) -> Result<Hc12<S, P, D, Normal>, Hc12<S, P, D, Configuration>>

Move Hc12 in config mode back to normal mode.

pub fn into_sleeping_mode(
    self
) -> Result<Hc12<S, P, D, Sleep>, Hc12<S, P, D, Configuration>>

Move Hc12 in config mode into sleeping mode.

pub fn is_ok(&mut self) -> bool

Check if Hc12 responds to “AT” query with “OK”.

pub fn get_version<'a>(&mut self, buffer: &'a mut [u8; 64]) -> &'a [u8]

Get version as a string from Hc12

pub fn reset_settings(&mut self) -> bool

Reset Hc12 to default settings.

pub fn get_parameters(&mut self) -> Option<Parameters>

Get parameters of Hc12

impl<S, P, D> Hc12<S, P, D, Sleep> where
    S: Read<u8> + Write<u8>,
    P: OutputPin,
    D: DelayMs<u32>, 

Implementation for Hc12 in sleeping mode.

pub fn into_configuration_mode(
    self
) -> Result<Hc12<S, P, D, Configuration>, Hc12<S, P, D, Sleep>>

Move Hc12 in sleeping mode back to configuration mode.

Trait Implementations

impl<S: Debug, P: Debug, D: Debug, M: Debug> Debug for Hc12<S, P, D, M> where
    S: Read<u8> + Write<u8>,
    P: OutputPin,
    D: DelayMs<u32>, 

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

Formats the value using the given formatter.

impl<S, P, D> Read<u8> for Hc12<S, P, D, Normal> where
    S: Read<u8> + Write<u8>,
    P: OutputPin,
    D: DelayMs<u32>, 

Implement Read for Hc12 in normal mode This just defers to the underlying serial implementation.

type Error = <S as Read<u8>>::Error

Read error

fn read(&mut self) -> Result<u8, Self::Error>

Reads a single word from the serial interface

impl<S, P, D> Write<u8> for Hc12<S, P, D, Normal> where
    S: Read<u8> + Write<u8>,
    P: OutputPin,
    D: DelayMs<u32>, 

Implement Write for Hc12 in normal mode. This just defers to the underlying serial implementation.

type Error = <S as Write<u8>>::Error

Write error

fn write(&mut self, word: u8) -> Result<(), Self::Error>

Writes a single word to the serial interface

fn flush(&mut self) -> Result<(), Self::Error>

Ensures that none of the previously written words are still buffered