node rfm9x

Introducción

Módulo Node.js para interactuar con los módulos inalámbricos RFM9X Lora. Destinado a usar con los gorros de radio Adafruit.

El código solo se ha probado en Raspberry Pi, pero técnicamente también podría trabajar en otros tableros compatibles con Onoff y SPI-Device.

Expresiones de gratitud

• El módulo CircuitPython RFM9X se usó como plantilla para la mayor parte de la lógica.
• Los módulos SPI-Device y Onoff de FIVDI hicieron que la interfaz con el hardware fuera realmente fácil.

Ejemplo

Consulte example/pingpong.js para obtener un ejemplo simple de recibir y enviar datos.

API

Los módulos exportan una sola clase RFM9x .

Clase RFM9x

Clase que representa el módulo Lora. El constructor no requiere argumentos.

 const rfm9x = require ( 'rfm9x' ) ;
const module = new rfm9x ( ) ;

await module . init ( { ... } ) ;

---

Propiedades

• debug - Output SPI Información de depuración

debug

Establezca esta propiedad en true para imprimir toda la comunicación SPI en la consola.

Nota: Porque las llamadas console.log() son síncronas en la mayoría de las circunstancias, ¡habilitando esto puede afectar el momento! Por ejemplo, podría causar cambiar de enviar al modo de recepción como lo suficientemente lento como para perder las respuestas de otros nodos.

---

Métodos

• init(options) - Inicializar el módulo y la configuración de Lora
• startReceive() : coloque el módulo Lora en modo de recepción y habilite el evento receive
• stopReceive() - Pon el módulo Lora en modo de espera y deje de recibir paquetes
• send(payload) - Enviar un paquete a través de Lora
• getVersion() - Obtenga el número de versión de chip del módulo

init(options)

• options - Opciones Objeto (ver más abajo). Todas las propiedades son opcionales, los valores predeterminados se utilizarán cuando se omitan.

Inicializar la configuración del módulo y lora. Debe llamarse antes de usar cualquiera de las funciones de radio.

Devuelve una promesa que se resuelve sin valor.

Se admiten las siguientes opciones:

• frequencyMhz - frecuencia base en MHz, predeterminado: 915
• preambleLength - longitud del preámbulo lora en bytes, predeterminado: 8
• bandwidthHz - ancho de banda de Lora en HZ, predeterminado: 500000
• Tasa de codificación codingRate - Lora, los valores válidos son 5 (4/5) a 8 (4/8), predeterminado: 5
• spreadingFactor - Factor de dispersión de lora, los valores válidos son de 6 a 12 , predeterminado: 7
• enableCrcChecking : si habilita la verificación de CRC en los paquetes entrantes, predeterminado: false
• txPowerDb - Potencia del transmisor En DB, los valores válidos son de 5 a 23 (actualmente solo se admite el modo de alta potencia), predeterminado: 23
• enableAgc : si habilita el control automático de ganancias, predeterminado: false
• resetPin - Número del pin GPIO al que está conectado la línea de reinicio RFM9X, predeterminado: 25
• dio0Pin - Número del pin GPIO al que está conectado la línea RFM9X DIO0, predeterminada: 22
• dio1Pin : no se usa actualmente. Número del pin GPIO al que está conectado la línea RFM9X DIO1, predeterminada: 23
• dio2Pin : no se usa actualmente. Número del pin GPIO al que está conectado la línea RFM9X DIO2, predeterminada: 24
• spiSpeedHz - Velocidad de la comunicación SPI en HZ, predeterminado: 100000
• txTimeoutMs - tiempo máximo en milisegundos para esperar a que finalice una transmisión de paquetes, predeterminado: 2000

startReceive()

Coloque el módulo Lora en modo de recepción y habilite el evento receive .

Devuelve una promesa que se resuelve sin valor.

stopReceive()

Coloque el módulo Lora en modo de espera y deje de recibir paquetes.

Devuelve una promesa que se resuelve sin valor.

send(payload)

• payload : un Buffer de hasta 255 bytes

Envía un paquete a través de Lora.

Devuelve una promesa que se resuelve sin valor después de que se termine la transmisión.

Nota: Después de transmitir un paquete, el módulo cambia automáticamente al modo de espera. Si desea continuar recibiendo paquetes después de una transmisión, deberá llamar startReceive() después de que se completara la transmisión.

getVersion()

Obtenga el número de versión de chip del módulo.

Devuelve una promesa que se resuelve con el número de versión (entero de un byte).

---

Eventos

• receive(packet) - emitido cuando se ha recibido un paquete Lora
• receiveError() - emitido cuando se ha recibido un paquete de Lora inválido

receive(packet)

Evento que se emite cuando se recibe un paquete Lora.

packet es un objeto que contiene las siguientes propiedades:

• payload : un Buffer que contiene el contenido del paquete
• rssiDb - RSSI del paquete en DB
• snrDb - SNR del paquete en DB

receiveError()

Evento que se emite cuando se recibe un paquete Lora pero se descartó debido a recibir errores (por ejemplo, falló en cheque CRC).