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

    Interface LorawanMacCommand

    One of the commands a network and a device configure each other with.

    kind names the command and cid is the identifier it travels under. Only the fields that command carries are set; the rest are null. The same identifier means a different command in each direction, so direction decides which one this is.

    interface LorawanMacCommand {
        action?: number;
        actionAck?: boolean;
        backOff?: number;
        battery?: number;
        bucketSize?: number;
        cadPeriodicity?: number;
        cadPeriodicityAck?: boolean;
        channelAck?: boolean;
        channelMask?: number;
        channelMaskAck?: boolean;
        cid: number;
        combinedRulesAck?: boolean;
        dataRate?: number;
        dataRateAck?: boolean;
        dataRateRangeOk?: boolean;
        defaultChannelIndex?: number;
        defaultChannelIndexAck?: boolean;
        delay?: number;
        devAddr?: number;
        direction: LorawanDirection;
        downlinkDwell?: boolean;
        enabled?: boolean;
        eui?: Buffer<ArrayBufferLike>;
        euiLen?: number;
        euiLenAck?: boolean;
        fraction?: number;
        frequencyHz?: number;
        frequencyOk?: boolean;
        gateways?: number;
        globalUplinkBucketSize?: number;
        globalUplinkReloadRate?: number;
        index?: number;
        indexAck?: boolean;
        joinRequestBucketSize?: number;
        joinRequestReloadRate?: number;
        kind: string;
        margin?: number;
        maskControl?: number;
        maxDataRate?: number;
        maxDutyCycle?: number;
        maxEirp?: number;
        minDataRate?: number;
        notifyBucketSize?: number;
        notifyReloadRate?: number;
        overallBucketSize?: number;
        overallReloadRate?: number;
        powerAck?: boolean;
        relayMode?: number;
        reloadRate?: number;
        resetLimitCounters?: number;
        rootWorSKey?: Buffer<ArrayBufferLike>;
        rssiDbm?: number;
        rx1Offset?: number;
        rx1OffsetAck?: boolean;
        rx2DataRate?: number;
        rx2DataRateAck?: boolean;
        secondChannelAckOffset?: number;
        secondChannelAckOffsetAck?: boolean;
        secondChannelDataRate?: number;
        secondChannelDataRateAck?: boolean;
        secondChannelFrequencyAck?: boolean;
        secondChannelIndex?: number;
        secondChannelIndexAck?: boolean;
        seconds?: number;
        smartEnableLevel?: number;
        snrDb?: number;
        snrMargin?: number;
        transmissions?: number;
        txPower?: number;
        uplinkDwell?: boolean;
        uplinkFrequencyExists?: boolean;
        wfcnt?: number;
    }
    Index
    action? actionAck? backOff? battery? bucketSize? cadPeriodicity? cadPeriodicityAck? channelAck? channelMask? channelMaskAck? cid combinedRulesAck? dataRate? dataRateAck? dataRateRangeOk? defaultChannelIndex? defaultChannelIndexAck? delay? devAddr? direction downlinkDwell? enabled? eui? euiLen? euiLenAck? fraction? frequencyHz? frequencyOk? gateways? globalUplinkBucketSize? globalUplinkReloadRate? index? indexAck? joinRequestBucketSize? joinRequestReloadRate? kind margin? maskControl? maxDataRate? maxDutyCycle? maxEirp? minDataRate? notifyBucketSize? notifyReloadRate? overallBucketSize? overallReloadRate? powerAck? relayMode? reloadRate? resetLimitCounters? rootWorSKey? rssiDbm? rx1Offset? rx1OffsetAck? rx2DataRate? rx2DataRateAck? secondChannelAckOffset? secondChannelAckOffsetAck? secondChannelDataRate? secondChannelDataRateAck? secondChannelFrequencyAck? secondChannelIndex? secondChannelIndexAck? seconds? smartEnableLevel? snrDb? snrMargin? transmissions? txPower? uplinkDwell? uplinkFrequencyExists? wfcnt?
    action?: number

    What a join filter rule does, or whether a trusted end device is read or removed.

    actionAck?: boolean

    Whether its action was valid.

    backOff?: number

    How many WOR frames without an acknowledgment before an uplink goes anyway.

    battery?: number

    A device battery level: 0 on external power, 255 when it cannot tell.

    bucketSize?: number

    Its bucket size multiplier, as TS011-1.0.1 table 55 codes it.

    cadPeriodicity?: number

    How often a relay scans, as TS011-1.0.1 table 18 codes it.

    cadPeriodicityAck?: boolean

    Whether the scan period was valid.

    channelAck?: boolean

    Whether the frequency was usable.

    channelMask?: number

    Which channels may carry an uplink.

    channelMaskAck?: boolean

    Whether the channel mask was usable.

    cid: number

    The identifier it travels under.

    combinedRulesAck?: boolean

    Whether a join filter rule was one to create, change or remove.

    dataRate?: number

    The data rate a network asks a device to use.

    dataRateAck?: boolean

    Whether the data rate was set.

    dataRateRangeOk?: boolean

    Whether the device can run that range of rates.

    defaultChannelIndex?: number

    Which of the region's relay channels is a relay's default one.

    defaultChannelIndexAck?: boolean

    Whether the default channel was valid.

    delay?: number

    How long a device waits before its first receive window, as the command codes it.

    devAddr?: number

    An end device address a relay command names.

    direction: LorawanDirection

    Which way it travels.

    downlinkDwell?: boolean

    Whether a downlink is.

    enabled?: boolean

    Whether a relay runs.

    eui?: Buffer<ArrayBufferLike>

    Those bytes, most significant first, with the rest zero.

    euiLen?: number

    How many leading bytes of JoinEUI and DevEUI a join filter rule matches.

    euiLenAck?: boolean

    Whether its length was valid.

    fraction?: number

    The fraction of that second, in steps of one part in 256.

    frequencyHz?: number

    A frequency in hertz, for the receive window and the channel commands.

    frequencyOk?: boolean

    Whether its radio can reach that frequency.

    gateways?: number

    How many gateways heard it.

    globalUplinkBucketSize?: number

    The global uplink bucket size multiplier.

    globalUplinkReloadRate?: number

    Uplinks a relay forwards an hour across every trusted end device.

    index?: number

    Which channel a channel command names.

    indexAck?: boolean

    Whether a trusted list entry was in use.

    joinRequestBucketSize?: number

    The join request bucket size multiplier.

    joinRequestReloadRate?: number

    Join requests a relay forwards an hour, 127 for no limit.

    kind: string

    Which command this is, as a name.

    margin?: number

    How far above the floor a link check arrived, in dB.

    maskControl?: number

    Which block of sixteen channels that mask applies to.

    maxDataRate?: number

    The fastest rate allowed on it.

    maxDutyCycle?: number

    The share of the air a device is held to, as one over two to this.

    maxEirp?: number

    The coded transmit power ceiling a region imposes.

    minDataRate?: number

    The slowest rate allowed on it.

    notifyBucketSize?: number

    The notification bucket size multiplier.

    notifyReloadRate?: number

    New end device notifications a relay sends an hour.

    overallBucketSize?: number

    The overall bucket size multiplier.

    overallReloadRate?: number

    Every message a relay sends an hour.

    powerAck?: boolean

    Whether the power was set.

    relayMode?: number

    How an end device uses a relay, as TS011-1.0.1 table 40 codes it.

    reloadRate?: number

    Tokens a trusted end device earns an hour, 63 for no limit.

    resetLimitCounters?: number

    What a forwarding limit command does to a relay's token counters, as table 63 codes it.

    rootWorSKey?: Buffer<ArrayBufferLike>

    An end device's root relay session key.

    rssiDbm?: number

    The signal strength of a WOR frame a relay could not verify, in dBm.

    rx1Offset?: number

    How far the first receive window sits below the uplink rate.

    rx1OffsetAck?: boolean

    Whether the window offset was in range.

    rx2DataRate?: number

    The rate of the second receive window.

    rx2DataRateAck?: boolean

    Whether the window rate was known.

    secondChannelAckOffset?: number

    How far above its frequency the second channel is acknowledged, as table 35 codes it.

    secondChannelAckOffsetAck?: boolean

    Whether its acknowledgment offset was valid.

    secondChannelDataRate?: number

    The second channel's data rate; its frequency is the frequency field.

    secondChannelDataRateAck?: boolean

    Whether the second channel's data rate was valid.

    secondChannelFrequencyAck?: boolean

    Whether its frequency was valid.

    secondChannelIndex?: number

    Whether a relay configuration sets a second channel, 1 for yes.

    secondChannelIndexAck?: boolean

    Whether the second channel index was valid.

    seconds?: number

    Seconds since the GPS epoch.

    smartEnableLevel?: number

    How many unanswered uplinks turn relaying on, as table 41 codes it.

    snrDb?: number

    Its signal-to-noise ratio, in dB.

    snrMargin?: number

    The signal-to-noise ratio of the last request, in dB.

    transmissions?: number

    How many times to send an unconfirmed uplink.

    txPower?: number

    The transmit power it may use, as a ceiling.

    uplinkDwell?: boolean

    Whether an uplink is held to 400 ms of air time.

    uplinkFrequencyExists?: boolean

    Whether the channel already had an uplink frequency to pair a downlink with.

    wfcnt?: number

    A wake-on-radio frame counter.

    Settings
    Member Visibility

    On This Page
    Properties
    actionactionAckbackOffbatterybucketSizecadPeriodicitycadPeriodicityAckchannelAckchannelMaskchannelMaskAckcidcombinedRulesAckdataRatedataRateAckdataRateRangeOkdefaultChannelIndexdefaultChannelIndexAckdelaydevAddrdirectiondownlinkDwellenabledeuieuiLeneuiLenAckfractionfrequencyHzfrequencyOkgatewaysglobalUplinkBucketSizeglobalUplinkReloadRateindexindexAckjoinRequestBucketSizejoinRequestReloadRatekindmarginmaskControlmaxDataRatemaxDutyCyclemaxEirpminDataRatenotifyBucketSizenotifyReloadRateoverallBucketSizeoverallReloadRatepowerAckrelayModereloadRateresetLimitCountersrootWorSKeyrssiDbmrx1Offsetrx1OffsetAckrx2DataRaterx2DataRateAcksecondChannelAckOffsetsecondChannelAckOffsetAcksecondChannelDataRatesecondChannelDataRateAcksecondChannelFrequencyAcksecondChannelIndexsecondChannelIndexAcksecondssmartEnableLevelsnrDbsnrMargintransmissionstxPoweruplinkDwelluplinkFrequencyExistswfcnt