FakeRadio
Defined in: packages/transports/src/mock/fake-radio.ts:92
Emulates the Companion firmware (FIRMWARE_VER_CODE 13) for the v1 command subset, attached to a
MockTransport. Used by @meshcorejs/testing and every test that needs a radio without hardware.
Constructors
Constructor
new FakeRadio(options?): FakeRadio;Defined in: packages/transports/src/mock/fake-radio.ts:112
Parameters
options?
FakeRadioOptions = {}
Initial self, device, contacts, channels and clock
Returns
FakeRadio
Properties
ackDelayMs
ackDelayMs: number = 50;Defined in: packages/transports/src/mock/fake-radio.ts:101
ackMode
ackMode: AckMode = 'auto';Defined in: packages/transports/src/mock/fake-radio.ts:100
appTargetVersion
appTargetVersion: number = 0;Defined in: packages/transports/src/mock/fake-radio.ts:99
batteryMillivolts
batteryMillivolts: number = 4100;Defined in: packages/transports/src/mock/fake-radio.ts:103
channels
readonly channels: (ChannelRecord | null)[];Defined in: packages/transports/src/mock/fake-radio.ts:96
commands
readonly commands: number[] = [];Defined in: packages/transports/src/mock/fake-radio.ts:98
contacts
readonly contacts: Map<string, ContactRecord>;Defined in: packages/transports/src/mock/fake-radio.ts:95
device
readonly device: DeviceInfo;Defined in: packages/transports/src/mock/fake-radio.ts:94
self
readonly self: SelfInfo;Defined in: packages/transports/src/mock/fake-radio.ts:93
selfAdvertPacket
selfAdvertPacket: Uint8Array;Defined in: packages/transports/src/mock/fake-radio.ts:105
sent
readonly sent: FakeSentMessage[] = [];Defined in: packages/transports/src/mock/fake-radio.ts:97
suggestedTimeoutMs
suggestedTimeoutMs: number;Defined in: packages/transports/src/mock/fake-radio.ts:104
unresponsive
unresponsive: boolean = false;Defined in: packages/transports/src/mock/fake-radio.ts:102
Accessors
clock
Get Signature
get clock(): number;Defined in: packages/transports/src/mock/fake-radio.ts:148
Returns
number
pendingMessages
Get Signature
get pendingMessages(): number;Defined in: packages/transports/src/mock/fake-radio.ts:245
Returns
number
Methods
ack()
ack(expectedAck, roundTripMs?): void;Defined in: packages/transports/src/mock/fake-radio.ts:241
Parameters
expectedAck
number
Value announced by SENT
roundTripMs?
number = 1200
Delay reported in the ACK. Default 1200
Returns
void
attach()
attach(transport): this;Defined in: packages/transports/src/mock/fake-radio.ts:153
Parameters
transport
MockTransport this radio answers
Returns
this
deleteContact()
deleteContact(publicKey): void;Defined in: packages/transports/src/mock/fake-radio.ts:232
Parameters
publicKey
string
Contact key
Returns
void
hearAdvert()
hearAdvert(contact): void;Defined in: packages/transports/src/mock/fake-radio.ts:206
Parameters
contact
ContactRecord
Record of the node heard
Returns
void
receiveChannelMessage()
receiveChannelMessage(params): void;Defined in: packages/transports/src/mock/fake-radio.ts:184
Parameters
params
channelIndex, senderName, text, and optional snr and hops
channelIndex
number
hops?
number
senderName
string
senderTimestamp?
number
snr?
number
text
string
Returns
void
receiveContactMessage()
receiveContactMessage(params): void;Defined in: packages/transports/src/mock/fake-radio.ts:160
Parameters
params
from, text, and optional snr, hops and senderTimestamp
from
string
hops?
number
senderTimestamp?
number
snr?
number
text
string
Returns
void
updatePath()
updatePath(publicKey, outPath): void;Defined in: packages/transports/src/mock/fake-radio.ts:223
Parameters
publicKey
string
Contact key
outPath
Path | null
New path, null for flood
Returns
void