Skip to main content

pamoja_lorawan_relay_start

pamoja_ffi::lorawan_relay_node

Function pamoja_lorawan_relay_start 

Source 
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_lorawan_relay_start(
    relay: *mut PamojaLorawanRelay,
    cad_periodicity: u8,
    default_channel_index: u8,
    has_second_channel: u8,
    second_wor_frequency_hz: u32,
    second_ack_frequency_hz: u32,
    second_data_rate: u8,
) -> PamojaStatus
Expand description

Starts the relay scanning, or changes what a running one scans.

§Arguments

  • relay - the relay.
  • cad_periodicity - how often it scans each channel, as TS011-1.0.1 table 18 codes it.
  • default_channel_index - which of the region’s wake-on-radio channels is the default one.
  • has_second_channel - 1 to scan a second channel as well.
  • second_wor_frequency_hz - where wake-on-radio frames arrive on it.
  • second_ack_frequency_hz - where the relay answers them.
  • second_data_rate - the data rate of both.

§Returns

PamojaStatus::Ok on success.

§Errors

Returns a failing status, with the reason on pamoja_lorawan_relay_error, for a reserved scan period, a channel the region does not define or the radio cannot tune, or scans too close together for the data rate.

§Safety

relay must be a live handle.