diff --git a/Basics.md b/Basics.md index ffa8ef4..31db468 100644 --- a/Basics.md +++ b/Basics.md @@ -7,8 +7,8 @@ The purpose if this page is to provide an overview of the basic usage of the lib - **SPI** modules: `Module(cs, irq, rst, gpio)`. For example: `RF69 rf = new Module(10, 2, 3);` - CS: this is the pin that's used as SPI chip select. - IRQ: this is the interrupt pin, it's usually connected to external interrupt on Arduino. It's a fast way for the module to tell Arduino something has happened - for example, a packet was received. All SPI modules have at least one interrupt pin. - - RST: most modules have a hardware reset pin. If the module doesn't have a reset or chip enable pin (e.g. CC1101), set `rst` to `NC`. - - GPIO: this is the fourth possible pin. It's optional for most modules, but may be required for some. SX127x requires additional interrupt pin to perform CAD and blocking receive. SX126x also uses this pin as the BUSY indication pin. If not in use, this pin can be left unassigned, or set to `NC`. + - RST: most modules have a hardware reset pin. If the module doesn't have a reset or chip enable pin (e.g. CC1101), set `rst` to `RADIOLIB_NC`. + - GPIO: this is the fourth possible pin. It's optional for most modules, but may be required for some. SX127x requires additional interrupt pin to perform CAD and blocking receive. SX126x also uses this pin as the BUSY indication pin. If not in use, this pin can be left unassigned, or set to `RADIOLIB_NC`. - **UART** modules: `Module(tx, rx)`. For example: `ESP8266 wifi = new Module(10, 9);` - Note: On some platforms that do not support SoftwareSerial, an instance of `HardwareSerial` can be provided to the constructor. When no instance is specified, the constructor will default to `Serial1`: `ESP8266 wifi = new Module(10, 9, &Serial1);`