Class Session

An activated LoRaWAN session: a device address and its two session keys.

Index

Constructors

Accessors

Methods

decode encodeDownlink encodeUplink rootWorSKey worKeys

Constructors

constructor

new Session(inner: LorawanSession): Session
Wraps an activated session.
Parameters
- inner: LorawanSession
  The generated session this facade delegates to.
Returns Session
- Defined in packages/lorawan/src/index.ts:482

Accessors

devAddr

get devAddr(): number
The device address this session is bound to.

Returns number
- Defined in packages/lorawan/src/index.ts:487

Methods

decode

decode(bytes: Uint8Array, fcnt: number): RxData
Verifies a received frame, then decrypts it.
Parameters
- bytes: Uint8Array
  The frame exactly as it came off the radio.
- fcnt: number
  The full 32-bit counter expected for this frame; its low 16 bits must match the counter the frame carries.
Returns RxData
The decoded frame.

Throws
If the MIC does not verify, the counter does not match, or the frame is not a data frame.
- Defined in packages/lorawan/src/index.ts:558

encodeDownlink

encodeDownlink(
    fcnt: number,
    fport: number,
    payload: Uint8Array,
    options?: Options,
): Buffer
Encodes a downlink, encrypting the payload and appending the MIC.
Parameters
- fcnt: number
  The frame counter for this downlink.
- fport: number
  The port; 0 for MAC commands, otherwise an application port.
- payload: Uint8Array
  The application payload to carry.
- Optionaloptions: Options
  The header flags and frame options to set.
Returns Buffer
The frame to transmit.

Throws
If the payload and options do not fit a single frame.
- Defined in packages/lorawan/src/index.ts:539

encodeUplink

encodeUplink(
    fcnt: number,
    fport: number,
    payload: Uint8Array,
    options?: Options,
): Buffer
Encodes an uplink, encrypting the payload and appending the MIC.
Parameters
- fcnt: number
  The frame counter for this uplink.
- fport: number
  The port; 0 for MAC commands, otherwise an application port.
- payload: Uint8Array
  The application payload to carry.
- Optionaloptions: Options
  The header flags and frame options to set.
Returns Buffer
The frame to transmit.

Throws
If the payload and options do not fit a single frame.
- Defined in packages/lorawan/src/index.ts:520

rootWorSKey

rootWorSKey(): Buffer
The root relay session key a network sends a relay for this device, TS011-1.0.1 section 4.4, derived from the network session key.

Returns Buffer
The 16-byte key.
- Defined in packages/lorawan/src/index.ts:497

worKeys

worKeys(): WorKeys
The keys this device's wake-on-radio frames are protected with, TS011-1.0.1 section 4.5.

Returns WorKeys
The integrity and encryption keys.
- Defined in packages/lorawan/src/index.ts:506