pamoja for TypeScript - v0.2.0
    Preparing search index...

    Class LorawanRelay

    A LoRaWAN relay: an end device that also listens for others, TS011-1.0.1.

    One turn runs like this: nextScan says when and where to listen, a wake-on-radio frame heard there goes to heardWor, the uplink behind it to heardUplink, and forward sends that to the network. What the relay's own windows hear goes to heardIn, which turns a downlink for the end device into one to send in its relay window.

    Index
    • get dataRate(): number

      The data rate the relay forwards at, which its acknowledgments report.

      Returns number

    • get devAddr(): number | null

      The address the relay's own device is on the network by.

      Returns number | null

    • get forwardDue(): number | null

      When the forwarded uplink waiting to go out is due, or null with nothing waiting.

      Returns number | null

    • get joined(): boolean

      Whether the relay's own device has joined.

      Returns boolean

    • get running(): boolean

      Whether the relay is scanning.

      Returns boolean

    • Reads the uplink a wake-on-radio frame announced, and holds it to forward.

      Returns when to forward it: fifty milliseconds after it ended.

      Parameters

      • frame: Buffer
      • rssiDbm: number
      • snrDb: number
      • endedUs: number

      Returns number

    • Reads a wake-on-radio frame a scan heard.

      Parameters

      • scan: LorawanScan
      • frame: Buffer
      • rssiDbm: number
      • snrDb: number
      • endedUs: number

      Returns LorawanWake

    • Says when and where to scan next, or null while the relay is stopped.

      Parameters

      • nowUs: number

      Returns LorawanScan | null

    • Says what comes next once the relay's own windows closed with nothing in them.

      Parameters

      • nowUs: number

      Returns LorawanNext

    • Sends one of the relay's own uplinks, which also carries what it owes its network.

      Parameters

      • port: number
      • payload: Buffer
      • confirmed: boolean
      • nowUs: number

      Returns LorawanTransmission

    • Stops scanning. A forwarded uplink already waiting still goes out.

      Returns void

    • Trusts an end device, as an UpdateUplinkListReq with the same fields does.

      Parameters

      • index: number
      • devAddr: number
      • rootWorSKey: Buffer
      • nextWfcnt: number
      • reloadRate: number
      • bucketSize: number

      Returns void

    • Clears the uplink a wake-on-radio frame announced, once listening heard nothing.

      Returns void