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

    Class LoraChannelPlan

    A regional channel plan, published or private.

    Index
    • get name(): string

      Returns the specification's name for the band.

      Returns string

    • Returns the centre frequency of one of the plan's default channels, or null past the last one the plan starts a device with.

      Parameters

      • channel: number

      Returns number | null

    • Returns the data rate a number selects, or null if the number is past the end of the plan's table.

      A number the region reserves is a data rate of kind Reserved, which is different from a number the plan never defines.

      Parameters

      Returns lora.LoraDataRate | null

    • Returns the share of time a transmitter may hold a frequency, in parts per thousand, or null if the frequency falls in no sub-band this plan describes.

      This reports the limit; it does not impose it. Pair it with loraMinOffTimeUs to turn the limit into the silence a frame costs.

      Parameters

      • frequencyHz: number

      Returns number | null

    • Returns the radio settings an uplink data rate selects, ready to hand to loraAirtimeUs, or null if the number is reserved or not carried by LoRa.

      Parameters

      • dataRate: number

      Returns lora.LoraLink | null

    • Returns the power ceiling that applies at a frequency, in dBm EIRP, falling back to the plan's default where no sub-band says otherwise.

      Parameters

      • frequencyHz: number

      Returns number

    • Returns the next lower data rate to fall back to during adaptive back-off, or null at the slowest rate the plan has.

      A device that has lost the network steps down this chain, trading airtime for range until it is heard again.

      Parameters

      • dataRate: number

      Returns number | null

    • Returns the downlink data rate the first receive window listens at, or null if the uplink data rate or offset is outside what the plan defines.

      Parameters

      • uplinkDataRate: number
      • offset: number
      • OptionaldwellLimited: boolean | null

      Returns number | null

    • Returns the radiated power a transmit-power index selects, in dBm, or null if the index is past the highest the plan defines.

      Parameters

      • index: number
      • maxEirpDbm: number

      Returns number | null