lora-comms 1.0.1 | Documentation

lora-comms

1.0.1

lora-comms ▸
- Static members
- .start
- .stop
- .uplink
- .downlink
- .active
- .start_logging
- .stop_logging
- .log_info
- .log_error
- .logging_active
- Events
- ⓔ stop
- ⓔ logging_stop
- ⓔ error

Need help reading this?

lora-comms

Module for reading and writing LoRa packets.

lora-comms

Extends events.EventEmitter

Static Members

▸ start(options)

Start the LoRa radio, receiving and transmitting packets to uplink and downlink.

start(options: Object)

Parameters

options (Object) Configuration options. This is passed to stream.Duplex when constructing uplink and downlink and supports the following additional option:

Name	Description
options.cfg_dir `string?`	Path to directory containing LoRa radio configuration files. Defaults to `packet_forwarder_shared/lora_pkt_fwd` in the module directory.

▸ stop()

Stop the LoRa radio.

A stop event is emitted when the radio stops.

stop()

▸ uplink

Duplex stream for receiving packets from the LoRa radio. Read PUSH_DATA packets. Write PUSH_ACK packets.

uplink

Type: stream.Duplex?

▸ downlink

Duplex stream for transmitting packets using the LoRa radio. Read PULL_DATA and TX_ACK packets. Write PULL_ACK and PULL_RESP packets.

downlink

Type: stream.Duplex?

▸ active

Whether the LoRa radio is switched on.

active

Type: boolean

▸ start_logging(options)

Start logging diagnostic messages to log_info and log_error.

start_logging(options: Object)

Parameters

options (Object) Configuration options. This is passed to stream.Readable when constructing log_info and log_error .

▸ stop_logging()

Stop logging diagnostic messages.

A logging_stop event is emitted when logging stops.

stop_logging()

▸ log_info

Readable stream containing diagnostic messages.

log_info

Type: stream.Readable?

▸ log_error

Readable stream containing diagnostic messages.

log_error

Type: stream.Readable?

▸ logging_active

Whether diagnostic logging is enabled.

logging_active

Type: boolean

Events

▸ stop

Stop event. Emitted when the radio stops.

stop

▸ logging_stop

Logging stop event. Emitted when logging stops.

logging_stop

▸ error

Error event.

error

Parameters

err (Object) The error which occurred.