Skip to main content

pamoja_lora_plan_max_payload

Function pamoja_lora_plan_max_payload 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_lora_plan_max_payload( plan: *const PamojaLoraPlan, table: u32, data_rate: u8, out_payload: *mut PamojaLoraMaxPayload, ) -> PamojaStatus
Expand description

Returns what a data rate may carry in one frame.

§Arguments

  • plan - the plan to read.
  • table - one of the PAMOJA_LORA_PAYLOAD_TABLE_* constants.
  • data_rate - the data-rate number.
  • out_payload - set to the limits on success.

§Returns

PamojaStatus::Ok on success.

§Errors

Returns PamojaStatus::InvalidArgument if either pointer is null, the table is not one of the constants, or the plan publishes no limit for that number. Returns PamojaStatus::Unsupported if the dwell-limited table was asked for and this plan has no dwell-time limit.

§Safety

plan must be a live plan handle and out_payload must point at writable storage for one PamojaLoraMaxPayload.