Class Network

The network side of one site: what a server does with what a gateway forwarded.

Index

Constructors

Methods

answer command notices register trustCommand uplink

Constructors

constructor

new Network(
    plan: lora.LoraChannelPlan,
    netId: number,
    windows?: gateway.NetworkWindows | null,
    firstDevAddr?: number | null,
): gateway.Network
Opens the network side of a site on a channel plan.

The plan is copied into the network, so it holds its band for as long as it runs.
Parameters
- plan: lora.LoraChannelPlan
- netId: number
- Optionalwindows: gateway.NetworkWindows | null
- OptionalfirstDevAddr: number | null
Returns gateway.Network
- Defined in packages/native/index.d.ts:776

Methods

answer

answer(
    devAddr: number,
    slot: gateway.Slot,
    fport: number,
    payload: Buffer,
): gateway.Txpk
Builds a downlink for a device, encrypted with its session.
Parameters
- devAddr: number
- slot: gateway.Slot
- fport: number
- payload: Buffer
Returns gateway.Txpk
- Defined in packages/native/index.d.ts:788

command

command(
    devAddr: number,
    slot: gateway.Slot,
    commands: LorawanMacCommand[],
): gateway.Txpk
Builds a downlink carrying MAC commands, which is how a network configures a relay.

The commands ride in the frame options where they fit, and in a frame of their own on port 0 where they do not.
Parameters
- devAddr: number
- slot: gateway.Slot
- commands: LorawanMacCommand[]
Returns gateway.Txpk
- Defined in packages/native/index.d.ts:803

notices

notices(): gateway.Notice[]
Takes the devices relays have reported hearing and could not verify, TS011-1.0.1 section 10.7.

A relay carries these in the MAC commands of its own uplinks, alongside whatever else that uplink was for, so they wait here until they are read.

Returns gateway.Notice[]
- Defined in packages/native/index.d.ts:796

register

register(
    devEui: Buffer,
    appEui: Buffer,
    appKey: Buffer,
    version?: LorawanVersion | null,
): void
Admits a device, so a join request signed with its key is accepted.
Parameters
- devEui: Buffer
- appEui: Buffer
- appKey: Buffer
- Optionalversion: LorawanVersion | null
  the link layer revision the device follows, 1.0.4 unless given. A 1.0.3 device's frames are refused once their counter runs MAX_FCNT_GAP ahead of the last one accepted, which TS001-1.0.4 no longer asks.
Returns void
- Defined in packages/native/index.d.ts:784

trustCommand

trustCommand(
    devAddr: number,
    index: number,
    reloadRate: number,
    bucketSize: number,
): LorawanMacCommand
Builds the command that tells a relay to trust a device, with the key that lets it verify the device's wake-on-radio frames, TS011-1.0.1 section 10.4.
Parameters
- devAddr: number
- index: number
- reloadRate: number
- bucketSize: number
Returns LorawanMacCommand
- Defined in packages/native/index.d.ts:808

uplink

uplink(heard: gateway.Rxpk): gateway.NetworkEvent
Reads a packet the gateway forwarded.
Parameters
- heard: gateway.Rxpk
Returns gateway.NetworkEvent
- Defined in packages/native/index.d.ts:786