Skip to content

Commit 425349a

Browse files
authored
Update README.md
1 parent ab519c1 commit 425349a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ void loop() {
8686

8787
```
8888

89-
The Corresponding receiver is also available:
89+
The corresponding receiver (also available in the examples folder):
9090

9191
```C++
9292

@@ -151,20 +151,20 @@ void loop() {
151151

152152
## Funtion reference
153153

154-
`void init(void)` must be called prior to using any other funtion. Will establish the necessary setup of the **CC1101** chip. Only exception: `getCC1101()`.
154+
`void init(void)` must be called prior to using any other function. Will establish the necessary setup of the **CC1101** chip. Only exception: `getCC1101()` may be called prior to `init()`.
155155

156-
`bool checkCRC(void)` Check if CRC is correct. Only meaningful after data is received via `receiveData()`.
156+
`bool checkCRC(void)` Check if CRC is correct. Returns `true` if CRCs match in last transmission. Only meaningful after data is received via `receiveData()`.
157157

158158
`bool getCC1101(void)` checks for the presence of a **CC1101** module on the SPI bus.
159159

160160
`uint8_t getLQI(void)` Link Quality Indicator. The Link Quality Indicator is a metric of the current quality of the received signal (smaller is better). When called after data is received via `receiveData()`. LQI corresponds to the data received. If called intermittently, returns the current link quality.
161-
161+
162162
`int8_t getRSSI(void)` Received Signal Strength Indicator. The value is the estimated signal strength in dBm. When called after data is received via `receiveData()`. RSSI corresponds to the data received. If called intermittently, returns the current signal strength.
163-
164-
`uint8_t receiveData(uint8_t *rxBuffer)` Check if data is received and copy it to rxBuffer. Returns 0 if no data is received yet, transmission is in progress or CRC wrong and `void setCRC_AF(true)`. If data was received, `setRX()`must be called again.
165-
163+
164+
`uint8_t receiveData(uint8_t *rxBuffer)` Check if data is received and copy it to rxBuffer. Returns 0 if no data is received yet, transmission is in progress or CRC wrong and `void setCRC_AF(true)`. If data was received, `setRX()`must be called again.
165+
166166
`void sendData(const char *txBuffer)` Sends the zero-terminated character string pointed to. Will return when data is sent. Must be max 61 characters including the trailing 0.
167-
167+
168168
`void sendData(const uint8_t *txBuffer, uint8_t size)` Sends size bytes pointed to by txBuffer. Must be max. 61 bytes.
169169

170170
`void setAddr(uint8_t addr)` On TX, sets the address of the package to be sent. On RX, determines from which address are acceptes if address check is enabled with `setAddrCheck`.
@@ -197,7 +197,7 @@ void loop() {
197197

198198
`void setDeviation(uint32_t deviation)` Set the frequency deviation in Hz. Possible values from 1586 to 380850. Default is 47607 Hz.
199199
> [!NOTE]
200-
> the effective deviation values are quantized and algorithm rounds down. Using the exact interval limits, the next lower value might be taken (e.g. for 47607, you must actually specify 4760**8**.
200+
> the effective deviation values are quantized and algorithm rounds down. Using the exact interval limits, the next lower value might be taken (e.g. for 47607, you must actually specify 4760**8**).
201201
202202
`void setFEC(bool fec)` Enable forward error correction. Only supported in fixed packet length mode (`PacketLengthConfig(pktl_FIXED)`) and `setCRCCheck(true)`.
203203

0 commit comments

Comments
 (0)