Struct cc1101_rust::config::CommonConfig

#[repr(C)]
pub struct CommonConfig { /* private fields */ }

Configuration values shared between transmit and receive

Implementations

impl CommonConfig

pub fn new(
    frequency: f32,
    modulation: Modulation,
    baud_rate: f32,
    deviation: Option<f32>,
    sync_word: Option<u32>
) -> Result<CommonConfig, CC1101Error>

Create a new CommonConfig

Example

let config = CommonConfig::new(433.92, Modulation::OOK, 1.0, None, None)?;

pub fn set_frequency(&mut self, frequency: f32) -> Result<(), CC1101Error>

The frequency to receive/transmit on.

Valid values are 300-348, 387-464 and 779-928 MHz.

pub fn get_frequency(&self) -> f32

Get the current receive/transmit frequency

pub fn set_modulation_and_baud_rate(
    &mut self,
    modulation: Modulation,
    baud_rate: f32
) -> Result<(), CC1101Error>

Set the modulation scheme and the baud rate in kBaud

Valid Modulation / Baud Rate Values

Modulation	Baud Rate
Modulation::OOK	0.6 - 250
Modulation::GFSK	0.6 - 250
Modulation::FSK2	0.6 - 500
Modulation::FSK4	0.6 - 300
Modulation::MSK	26 - 500

pub fn get_modulation(&self) -> Modulation

Get the current modulation

pub fn get_baud_rate(&self) -> f32

Get the current baud rate in kBaud

pub fn set_deviation(&mut self, deviation: f32) -> Result<(), CC1101Error>

Set the frequency deviation in kHz

pub fn get_deviation(&self) -> f32

Get the frequency deviation in kHz

pub fn set_sync_word(&mut self, sync_word: u32) -> Result<(), CC1101Error>

Set the sync word

Any sync word between 0x0000 and 0xFFFF is allowed. Above 0xFFFF, the high and low 16-bits must be the same (e.g 0x0f0f0f0f).

In RX, the device searches for the specified sync word to begin reception.

In TX, the sync word is prepended to each packet.

pub fn get_sync_word(&self) -> u32

Get the configured sync word

Trait Implementations

impl Clone for CommonConfig

fn clone(&self) -> CommonConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommonConfig

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

Formats the value using the given formatter.

impl Default for CommonConfig

fn default() -> CommonConfig

Returns the “default value” for a type.

impl Display for CommonConfig

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

Formats the value using the given formatter.

impl PartialEq<CommonConfig> for CommonConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CommonConfig