jacob.eva/opencom_xl_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move documentation files and add links

Browse Source
This commit is contained in:
jacob.eva 2024-05-20 12:48:52 +01:00
parent dcb8388ca9
commit 35d9ec2bab
No known key found for this signature in database
GPG Key ID: 0B92E083BBCCAA1E
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md → Documentation/CONTRIBUTING.md
View File

@ -11,7 +11,7 @@ This entry should include, at a minimum, the following:
* RX and TX leds (preferably LEDs of different colours) * RX and TX leds (preferably LEDs of different colours)
An example of a minimal entry can be seen below: An example of a minimal entry can be seen below:
` ```
#elif BOARD_MODEL == BOARD_MY_WICKED_BOARD #elif BOARD_MODEL == BOARD_MY_WICKED_BOARD
#define HAS_BLUETOOTH true #define HAS_BLUETOOTH true
#define HAS_PMU true #define HAS_PMU true
@ -28,7 +28,7 @@ An example of a minimal entry can be seen below:
// const int pin_busy = 0; not present // const int pin_busy = 0; not present
const int pin_led_rx = 5; const int pin_led_rx = 5;
const int pin_led_tx = 6; const int pin_led_tx = 6;
` ```
In some cases the SPI pins will not be required, as they will be the default pins for the SPI library supporting the board anyway, and therefore do not need overriding in the config. In some cases the SPI pins will not be required, as they will be the default pins for the SPI library supporting the board anyway, and therefore do not need overriding in the config.
@ -39,7 +39,7 @@ If the SX1262 is being used the following should also be considered:
* the enable pin for the TCXO (if present) * the enable pin for the TCXO (if present)
An example of an entry using the SX1262 modem can be seen below: An example of an entry using the SX1262 modem can be seen below:
` ```
#elif BOARD_MODEL == BOARD_MY_WICKED_BOARD #elif BOARD_MODEL == BOARD_MY_WICKED_BOARD
#define HAS_BLUETOOTH true #define HAS_BLUETOOTH true
#define HAS_PMU true #define HAS_PMU true
@ -62,13 +62,13 @@ An example of an entry using the SX1262 modem can be seen below:
const int pin_tcxo_enable = -1; const int pin_tcxo_enable = -1;
const int pin_led_rx = 5; const int pin_led_rx = 5;
const int pin_led_tx = 6; const int pin_led_tx = 6;
` ```
If the SX1280 is being used, the following should also be added: If the SX1280 is being used, the following should also be added:
* the TXEN and RXEN pins * the TXEN and RXEN pins
An example of an entry using the SX1280 modem can be seen below: An example of an entry using the SX1280 modem can be seen below:
` ```
#elif BOARD_MODEL == BOARD_MY_WICKED_BOARD #elif BOARD_MODEL == BOARD_MY_WICKED_BOARD
#define HAS_BLUETOOTH true #define HAS_BLUETOOTH true
#define HAS_PMU true #define HAS_PMU true
@ -91,7 +91,7 @@ An example of an entry using the SX1280 modem can be seen below:
const int pin_tcxo_enable = -1; const int pin_tcxo_enable = -1;
const int pin_led_rx = 5; const int pin_led_rx = 5;
const int pin_led_tx = 6; const int pin_led_tx = 6;
` ```
Please submit this, and any other support in different areas of the project your board may require, as a PR for my consideration. Please submit this, and any other support in different areas of the project your board may require, as a PR for my consideration.

0
FAQ.md → Documentation/FAQ.md
View File

8
README.md
View File

@ -43,7 +43,7 @@ You must have at least version `2.1.3` of `rnodeconf` installed to update the RN
| Heltec LoRa32 v3 | [Buy here](https://heltec.org/project/wifi-lora-32-v3/) | SX1276/8 | ESP32 | | Heltec LoRa32 v3 | [Buy here](https://heltec.org/project/wifi-lora-32-v3/) | SX1276/8 | ESP32 |
| Homebrew ESP32 boards | | Any supported | ESP32 | This can be any board with an Adafruit Feather (or generic) ESP32 chip | | Homebrew ESP32 boards | | Any supported | ESP32 | This can be any board with an Adafruit Feather (or generic) ESP32 chip |
It's easy to create your own RNodes from one of the supported development boards and devices. If a device or board you want to use is not yet supported, you are welcome to [join the effort](/CONTRIBUTING.md) and help create a board definition and pin mapping for it! It's easy to create your own RNodes from one of the supported development boards and devices. If a device or board you want to use is not yet supported, you are welcome to [join the effort](Documentation/CONTRIBUTING.md) and help create a board definition and pin mapping for it!
<!--<img src="Documentation/images/devboards_1.webp" width="100%"/>--> <!--<img src="Documentation/images/devboards_1.webp" width="100%"/>-->
@ -113,6 +113,9 @@ For more detailed instruction and in-depth guides, you can have a look at some o
- Once you've got the hang of it, start building RNodes for your community, or [even for selling them](https://unsigned.io/sell_rnodes.html) - Once you've got the hang of it, start building RNodes for your community, or [even for selling them](https://unsigned.io/sell_rnodes.html)
## Support development ## Support development
### Contributing
You can contribute features and board support to the project if you wish. Please see [here](Documentation/CONTRIBUTING.md).
### Hardware donations ### Hardware donations
If you would like to see support added for a board which you possess, you may donate it to myself, Jacob Eva, so that I can implement support for it into this project. There will be no official timescale given for implementation however, but I will try my best when I have time :) Please [contact me (scroll to the bottom)](https://liberatedsystems.co.uk/about) if you wish to donate hardware to the project. If you would like to see support added for a board which you possess, you may donate it to myself, Jacob Eva, so that I can implement support for it into this project. There will be no official timescale given for implementation however, but I will try my best when I have time :) Please [contact me (scroll to the bottom)](https://liberatedsystems.co.uk/about) if you wish to donate hardware to the project.
@ -139,6 +142,9 @@ You can help support the continued development of open, free and private communi
``` ```
- Ko-Fi: https://ko-fi.com/markqvist - Ko-Fi: https://ko-fi.com/markqvist
## FAQ
Please see [here](Documentation/FAQ.md).
## License & Use ## License & Use
The upstream RNode Firmware is Copyright © 2024 Mark Qvist / [unsigned.io](https://unsigned.io). The upstream RNode Firmware is Copyright © 2024 Mark Qvist / [unsigned.io](https://unsigned.io).
The modified RNode Firmware CE (community edition) is Copyright © Jacob Eva / [Liberated Embedded Systems](https://liberatedsystems.co.uk) and is made available under the **GNU General Public License v3.0**. The modified RNode Firmware CE (community edition) is Copyright © Jacob Eva / [Liberated Embedded Systems](https://liberatedsystems.co.uk) and is made available under the **GNU General Public License v3.0**.