Update Readme and comments
authorNathael Pajani <nathael.pajani@ed3l.fr>
Wed, 18 Jan 2023 02:18:20 +0000 (03:18 +0100)
committerNathael Pajani <nathael.pajani@ed3l.fr>
Wed, 18 Jan 2023 02:18:20 +0000 (03:18 +0100)
transparent_bridge/README
transparent_bridge/main.c

index f956ddf..1562d6b 100644 (file)
@@ -1,6 +1,6 @@
-Support for the Sub 1GHz module in USB or UEXT version
+Simple transparent bridge example for the RF Sub 1GHz module
 
-Copyright 2013 Nathael Pajani <nathael.pajani@ed3l.fr>
+Copyright 2021 Nathael Pajani <nathael.pajani@ed3l.fr>
 
 
 /* ****************************************************************************
@@ -19,10 +19,20 @@ Copyright 2013 Nathael Pajani <nathael.pajani@ed3l.fr>
  *
  *************************************************************************** */
 
-This module uses the CC1101 transceiver to provide Sub 1GHz Rf connectivity.
+This app uses the RF-Sub1GHz module from Techno-Innov to create an example of a
+transparent bridge between UART0 and 868MHz RF.
 
-The module also integrates a TMP101 temparature sensor, the usual bi-color led
-used for status, a RTC quartz, a DC-DC step-up for button battery power source
-support, and an extension port with a set of gpio, including ADC (2), PWM (2),
-I2C and SWD debug port.
+This example has been kept very simple, thus there's no check on what's
+received on the serial line, which has to be valid RF packets (with first byte
+indicating length and second byte indicating destination address or broadcast).
+
+The RF-Sub1GHz module uses CC1101 transceiver to provide Sub 1GHz Rf
+connectivity.
+
+Depending on the version, the module also integrates a TMP101 temparature
+sensor, the usual bi-color led used for status, a RTC quartz, a DC-DC step-up
+for button battery power source support, and extension ports with a set of
+gpio, including ADC, PWM, I2C, SPI, UART and SWD debug port.
+
+Refer to the RF-Sub1GHz module's reference manual for more information.
 
index 6c2bbe3..49a67a6 100644 (file)
@@ -163,7 +163,7 @@ void handle_rf_rx_data(void)
 
 
 /* Data sent on radio comes from the UART, put any data received from UART in
- * cc_tx_buff and send when either '\r' or '\n' is received.
+ * cc_tx_buff and send when enough data is received.
  * This function is very simple and data received between cc_tx flag set and
  * cc_ptr rewind to 0 may be lost. */
 static volatile uint8_t cc_tx = 0;