Struct chirpstack_api::api::DeviceProfile

pub struct DeviceProfile {

    pub id: String,
    pub tenant_id: String,
    pub name: String,
    pub description: String,
    pub region: i32,
    pub mac_version: i32,
    pub reg_params_revision: i32,
    pub adr_algorithm_id: String,
    pub payload_codec_runtime: i32,
    pub payload_codec_script: String,
    pub flush_queue_on_activate: bool,
    pub uplink_interval: u32,
    pub device_status_req_interval: u32,
    pub supports_otaa: bool,
    pub supports_class_b: bool,
    pub supports_class_c: bool,
    pub class_b_timeout: u32,
    pub class_b_ping_slot_nb_k: u32,
    pub class_b_ping_slot_dr: u32,
    pub class_b_ping_slot_freq: u32,
    pub class_c_timeout: u32,
    pub abp_rx1_delay: u32,
    pub abp_rx1_dr_offset: u32,
    pub abp_rx2_dr: u32,
    pub abp_rx2_freq: u32,
    pub tags: HashMap<String, String>,
    pub measurements: HashMap<String, Measurement>,
    pub auto_detect_measurements: bool,
    pub region_config_id: String,
}

Fields

id: String

Device-profile ID (UUID). Note: on create this will be automatically generated.

tenant_id: String

Tenant ID (UUID).

name: String

Name.

description: String

Description.

region: i32

Region.

mac_version: i32

LoRaWAN mac-version.

reg_params_revision: i32

Regional parameters revision.

adr_algorithm_id: String

ADR algorithm ID.

payload_codec_runtime: i32

Payload codec runtime.

payload_codec_script: String

Payload codec script.

flush_queue_on_activate: bool

Flush queue on device activation.

uplink_interval: u32

Uplink interval (seconds). This defines the expected uplink interval which the device uses for communication. If the uplink interval has expired and no uplink has been received, the device is considered inactive.

device_status_req_interval: u32

Device-status request interval (times / day). This defines the times per day that ChirpStack will request the device-status from the device.

supports_otaa: bool

Supports OTAA.

supports_class_b: bool

Supports Class B.

supports_class_c: bool

Supports Class-C.

class_b_timeout: u32

Class-B timeout (seconds). This is the maximum time ChirpStack will wait to receive an acknowledgement from the device (if requested).

class_b_ping_slot_nb_k: u32

Class-B ping-slots per beacon period. Valid options are: 0 - 7.

The actual number of ping-slots per beacon period equals to 2^k.

class_b_ping_slot_dr: u32

Class-B ping-slot DR.

class_b_ping_slot_freq: u32

Class-B ping-slot freq (Hz).

class_c_timeout: u32

Class-C timeout (seconds). This is the maximum time ChirpStack will wait to receive an acknowledgement from the device (if requested).

abp_rx1_delay: u32

RX1 delay (for ABP).

abp_rx1_dr_offset: u32

RX1 DR offset (for ABP).

abp_rx2_dr: u32

RX2 DR (for ABP).

abp_rx2_freq: u32

RX2 frequency (for ABP, Hz).

tags: HashMap<String, String>

User defined tags.

measurements: HashMap<String, Measurement>

Measurements. If defined, ChirpStack will visualize these metrics in the web-interface.

auto_detect_measurements: bool

Auto-detect measurements. If set to true, measurements will be automatically added based on the keys of the decoded payload. In cases where the decoded payload contains random keys in the data, you want to set this to false.

region_config_id: String

Region configuration ID. If set, devices will only use the associated region. If let blank, then devices will use all regions matching the selected common-name. Note that multiple region configurations can exist for the same common-name, e.g. to provide an 8 channel and 16 channel configuration for the US915 band.

Implementations

impl DeviceProfile

pub fn region(&self) -> Region

Returns the enum value of region, or the default if the field is set to an invalid enum value.

pub fn set_region(&mut self, value: Region)

Sets region to the provided enum value.

pub fn mac_version(&self) -> MacVersion

Returns the enum value of mac_version, or the default if the field is set to an invalid enum value.

pub fn set_mac_version(&mut self, value: MacVersion)

Sets mac_version to the provided enum value.

pub fn reg_params_revision(&self) -> RegParamsRevision

Returns the enum value of reg_params_revision, or the default if the field is set to an invalid enum value.

pub fn set_reg_params_revision(&mut self, value: RegParamsRevision)

Sets reg_params_revision to the provided enum value.

pub fn payload_codec_runtime(&self) -> CodecRuntime

Returns the enum value of payload_codec_runtime, or the default if the field is set to an invalid enum value.

pub fn set_payload_codec_runtime(&mut self, value: CodecRuntime)

Sets payload_codec_runtime to the provided enum value.

Trait Implementations

impl Clone for DeviceProfile

fn clone(&self) -> DeviceProfile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceProfile

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

Formats the value using the given formatter.

impl Default for DeviceProfile

fn default() -> Self

Returns the “default value” for a type.

impl Message for DeviceProfile

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
    B: BufMut,
    Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where
    Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
    B: BufMut,
    Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where
    Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where
    B: Buf,
    Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
    B: Buf,
    Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
    B: Buf,
    Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
    B: Buf,
    Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<DeviceProfile> for DeviceProfile

fn eq(&self, other: &DeviceProfile) -> 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 DeviceProfile