Skip to main content

pamoja_lora_plan_link_settings

pamoja_ffi::lora_region

Function pamoja_lora_plan_link_settings 

Source 
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_lora_plan_link_settings(
    plan: *const PamojaLoraPlan,
    data_rate: u8,
    out_link: *mut PamojaLoraLink,
) -> PamojaStatus
Expand description

Returns the radio settings an uplink data rate selects.

This is what turns a data-rate number into something a radio can be told: the spreading factor and bandwidth to transmit at, ready for pamoja_lora_airtime_us.

§Arguments

  • plan - the plan to read.
  • data_rate - the uplink data-rate number.
  • out_link - set to the radio settings on success.

§Returns

PamojaStatus::Ok on success.

§Errors

Returns PamojaStatus::InvalidArgument if either pointer is null, and PamojaStatus::Unsupported if the number is reserved or names a rate that is not LoRa, which has no spreading factor to report.

§Safety

plan must be a live plan handle and out_link must point at writable storage for one PamojaLoraLink.