Add rf_hopping Readme
authorNathael Pajani <nathael.pajani@ed3l.fr>
Sun, 5 Feb 2023 02:42:39 +0000 (03:42 +0100)
committerNathael Pajani <nathael.pajani@ed3l.fr>
Sun, 5 Feb 2023 02:42:39 +0000 (03:42 +0100)
rf_hopping/README [new file with mode: 0644]

diff --git a/rf_hopping/README b/rf_hopping/README
new file mode 100644 (file)
index 0000000..875e9b9
--- /dev/null
@@ -0,0 +1,41 @@
+Simple example for the RF Sub 1GHz module demonstrating RF channel switch
+
+Copyright 2021 Nathael Pajani <nathael.pajani@ed3l.fr>
+
+
+/* ****************************************************************************
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ *************************************************************************** */
+
+This app uses the RF-Sub1GHz module from Techno-Innov to create an example of a
+ data transmission to different peers on different channels over 868MHz RF.
+
+This example has been kept very simple to test sending to multiple peers over
+ different channels for a specific application.
+Data received on the serial line is sent to peers on configured tx channel
+ (unless it is configuration data).
+Data received on RF rx channel is dropped.
+
+
+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, a 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 UARTs, ADC, PWM, I2C, SPI, and SWD debug port.
+Refer to the README shipped with the electronics sources or to the RF-Sub1GHz
+ module's reference manual for more information.
+