Class DutyCycle

The silence a radio owes after its transmissions under a duty-cycle limit.

Index

Constructors

Accessors

earliestUs permille

Methods

ready transmitted waitUs

Constructors

constructor

new DutyCycle(permille: number): radios.DutyCycle
Creates a guard for a limit in parts per thousand, ready to transmit at once.

10 is 1%; 0 forbids transmitting and 1000 or more imposes no silence.
Parameters
- permille: number
Returns radios.DutyCycle
- Defined in packages/native/index.d.ts:2766

Accessors

earliestUs

get earliestUs(): number | null
The earliest time the next transmission may start, in microseconds on the caller's clock, or null when the limit forbids transmitting.

Returns number | null
- Defined in packages/native/index.d.ts:2773

permille

get permille(): number
The limit the guard enforces, in parts per thousand.

Returns number
- Defined in packages/native/index.d.ts:2768

Methods

ready

ready(nowUs: number): boolean
Whether a transmission may start at a time in microseconds on the caller's clock.
Parameters
- nowUs: number
Returns boolean
- Defined in packages/native/index.d.ts:2780

transmitted

transmitted(
    startedUs: number,
    link: lora.LoraLink,
    payloadLength: number,
): number
Records a transmission and the silence it owes, returning its airtime in microseconds.
Parameters
- startedUs: number
- link: lora.LoraLink
- payloadLength: number
Returns number
- Defined in packages/native/index.d.ts:2785

waitUs

waitUs(nowUs: number): number | null
How long the radio must still stay silent, in microseconds, or null when the limit forbids transmitting.
Parameters
- nowUs: number
Returns number | null
- Defined in packages/native/index.d.ts:2778