PIB Attributes Reference

The PAN Information Base (PIB) is the MAC-layer configuration interface defined by IEEE 802.15.4. The zigbee-mac crate exposes PIB attributes through the MacDriver trait’s mlme_get() and mlme_set() methods.

#![allow(unused)]
fn main() {
use zigbee_mac::{PibAttribute, PibValue, MacDriver};

// Read current channel
let channel = mac.mlme_get(PibAttribute::PhyCurrentChannel).await?;

// Set short address after joining
mac.mlme_set(
    PibAttribute::MacShortAddress,
    PibValue::ShortAddress(ShortAddress(0x1234)),
).await?;
}

PibAttribute Variants

Addressing (set during join)

Network Configuration

Beacon (Non-Beacon Mode)

TX/RX Tuning

Sequence Numbers

Indirect TX (Coordinator/Router)

Debug / Special

PHY Attributes (via MAC GET/SET)

PibValue Variants

The PibValue enum is the value container for all PIB GET/SET operations:

PibPayload

Fixed-capacity beacon payload buffer:

#![allow(unused)]
fn main() {
pub struct PibPayload {
    buf: [u8; 52],
    len: usize,
}

impl PibPayload {
    pub fn new() -> Self;                       // Empty payload
    pub fn from_slice(data: &[u8]) -> Option<Self>;  // None if > 52 bytes
    pub fn as_slice(&self) -> &[u8];            // Current content
}
}

Convenience Accessors on PibValue

Each variant has a corresponding accessor that returns Option:

PHY Constants & Helpers

#![allow(unused)]
fn main() {
/// Base superframe duration in symbols (960)
pub const A_BASE_SUPERFRAME_DURATION: u32 = 960;

/// Symbol rate at 2.4 GHz in symbols/second
pub const SYMBOL_RATE_2_4GHZ: u32 = 62_500;

/// Calculate scan duration per channel in symbols
pub fn scan_duration_symbols(exponent: u8) -> u32;

/// Calculate scan duration per channel in microseconds
pub fn scan_duration_us(exponent: u8) -> u64;
}

Usage Patterns

Reading current network state

#![allow(unused)]
fn main() {
let short = mac.mlme_get(PibAttribute::MacShortAddress).await?
    .as_short_address().unwrap();
let pan = mac.mlme_get(PibAttribute::MacPanId).await?
    .as_pan_id().unwrap();
let channel = mac.mlme_get(PibAttribute::PhyCurrentChannel).await?
    .as_u8().unwrap();
}

Configuring TX performance

#![allow(unused)]
fn main() {
// More aggressive: fewer backoffs, more retries
mac.mlme_set(PibAttribute::MacMaxCsmaBackoffs, PibValue::U8(3)).await?;
mac.mlme_set(PibAttribute::MacMaxFrameRetries, PibValue::U8(5)).await?;
mac.mlme_set(PibAttribute::MacMinBe, PibValue::U8(2)).await?;
}

Setting up a sleepy end device

#![allow(unused)]
fn main() {
// Disable RX during idle for battery saving
mac.mlme_set(PibAttribute::MacRxOnWhenIdle, PibValue::Bool(false)).await?;
// Enable auto data request after beacon
mac.mlme_set(PibAttribute::MacAutoRequest, PibValue::Bool(true)).await?;
}

Adjusting TX power

#![allow(unused)]
fn main() {
// Set to +4 dBm
mac.mlme_set(PibAttribute::PhyTransmitPower, PibValue::I8(4)).await?;
// Read back actual power (may be clamped by hardware)
let actual = mac.mlme_get(PibAttribute::PhyTransmitPower).await?;
}