node rfm9x Téléchargement - node rfm9x Téléchargement du code source

node rfm9x

Code Source AI

v1.0.1

Télécharger

Introduction

Module Node.js pour interfacer avec les modules sans fil RFM9X LORA. Destiné à être utilisé avec Adafruit Radio Bonnets.

Le code n'a été testé que sur Raspberry Pi, mais pourrait techniquement fonctionner sur d'autres conseils soutenus par OOFF et SPI-Device.

Remerciements

Le module CircuitPython RFM9X a été utilisé comme modèle pour la majeure partie de la logique.
Les modules SPI-Device et ONOFF par FIVDI ont rendu l'interfaçage avec le matériel vraiment facile.

Exemple

Voir example/pingpong.js pour un exemple simple de réception et d'envoi de données.

API

Les modules exportent une seule classe RFM9x .

Classe `RFM9x`

Classe représentant le module LORA. Le constructeur ne nécessite aucun argument.

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

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

Propriétés

debug - Informations sur le débogage SPI de sortie

`debug`

Définissez cette propriété sur true pour obtenir toute la communication SPI imprimée sur la console.

Remarque: Parce que console.log() Les appels sont synchrones dans la plupart des cas, permettant à cela peut avoir un impact sur le timing! Par exemple, cela peut entraîner le passage de l'envoi vers le mode de réception pour être suffisamment lent pour manquer les réponses des autres nœuds.

Méthodes

init(options) - Initialiser le module et les paramètres LORA
startReceive() - Mettez le module LORA en mode de réception et activez l'événement receive
stopReceive() - Mettez le module LORA en mode veille et arrêtez de recevoir des paquets
send(payload) - Envoyer un paquet via Lora
getVersion() - Obtenez le numéro de version de la puce à partir du module

`init(options)`

options - Objet Options (voir ci-dessous). Toutes les propriétés sont facultatives, les valeurs par défaut seront utilisées lorsqu'elles seront omises.

Initialisez les paramètres du module et LORA. Doit être appelé avant d'utiliser l'une des fonctions radio.

Renvoie une promesse qui résout sans valeur.

Les options suivantes sont prises en charge:

frequencyMhz - fréquence de base en MHz, par défaut: 915
preambleLength - Lora Longue de préambule en octets, par défaut: 8
bandwidthHz - Lora Bandwidth in Hz, par défaut: 500000
codingRate - Taux de codage LORA, les valeurs valides sont 5 (4/5) à 8 (4/8), par défaut: 5
spreadingFactor - Facteur de propagation LORA, les valeurs valides sont de 6 à 12 , par défaut: 7
enableCrcChecking - s'il faut activer la vérification du CRC sur les paquets entrants, par défaut: false
txPowerDb - Power de l'émetteur en dB, les valeurs valides sont de 5 à 23 (actuellement seul le mode de puissance est pris en charge), par défaut: 23
enableAgc - s'il faut permettre le contrôle automatique du gain, par défaut: false
resetPin - Numéro de la broche GPIO à laquelle la ligne de réinitialisation RFM9X est connectée, par défaut: 25
dio0Pin - Nombre de la broche GPIO à laquelle la ligne RFM9X Dio0 est connectée, par défaut: 22
dio1Pin - pas actuellement utilisé. Numéro de la broche GPIO à laquelle la ligne RFM9X Dio1 est connectée, par défaut: 23
dio2Pin - non utilisé actuellement. Numéro de la broche GPIO à laquelle la ligne RFM9X Dio2 est connectée, par défaut: 24
spiSpeedHz - Vitesse de la communication SPI en Hz, par défaut: 100000
txTimeoutMs - Temps maximum en millisecondes pour attendre qu'une transmission de paquets se termine, par défaut: 2000

`startReceive()`

Mettez le module LORA en mode de réception et activez l'événement receive .

Renvoie une promesse qui résout sans valeur.

`stopReceive()`

Mettez le module LORA en mode veille et arrêtez de recevoir des paquets.

Renvoie une promesse qui résout sans valeur.

`send(payload)`

payload - un Buffer allant jusqu'à 255 octets

Envoyez un paquet via Lora.

Renvoie une promesse qui se résout sans valeur une fois la transmission terminée.

Remarque: Après avoir transmis un paquet, le module passe automatiquement en mode veille. Si vous souhaitez continuer à recevoir des paquets après une transmission, vous devrez appeler startReceive() une fois la transmission terminée.