From 4f650416f19f29b585be4f709ce558eabbc151e5 Mon Sep 17 00:00:00 2001 From: TrystanLea Date: Fri, 17 Feb 2023 10:39:09 +0000 Subject: [PATCH] update readme --- firmware/emonth2.ino | 2 +- readme.md | 28 ++-------------------------- 2 files changed, 3 insertions(+), 27 deletions(-) diff --git a/firmware/emonth2.ino b/firmware/emonth2.ino index e399301..4c23c77 100644 --- a/firmware/emonth2.ino +++ b/firmware/emonth2.ino @@ -77,7 +77,7 @@ const char *firmware_version = {"4.1.0\n\r"}; #define RFM69_JEELIB_NATIVE 2 #define RFM69_LOW_POWER_LABS 3 -#define RadioFormat RFM69_JEELIB_NATIVE +#define RadioFormat RFM69_LOW_POWER_LABS bool flash_led = false; // true = Flash LED after each sample (increases battery drain) diff --git a/readme.md b/readme.md index 6e66c66..d943777 100644 --- a/readme.md +++ b/readme.md @@ -10,40 +10,16 @@ The emonTH V2 is an open-source, wireless, battery powered temperature and humid Data from the emonTH is transmitted via wireless RF (433MHz) to an emonPi / emonBase web-connected base-station for logging to Emoncms for data logging, processing and graphing. - ![emonTH V2](docs/img/emonth2.png) ## Documentation - [Overview](https://docs.openenergymonitor.org/emonth2/overview.html) - [Installation](https://docs.openenergymonitor.org/emonth2/install.html) +- [Firmware](https://docs.openenergymonitor.org/emonth2/firmware.html) +- [Configuration](https://docs.openenergymonitor.org/emonth2/configuration.html) - [Technical](https://docs.openenergymonitor.org/emonth2/technical.html) -## Hardware - -- Hardware schematic & CAD files are in the `hardware` folder of this repo - -## Firmware - -### Pre-compiled - -Either upload pre-compiled firmware (from github releases) using our [emonUpload tool](https://github.com/openenergymonitor/emonupload) or compile and upload - -### Compile & Upload - -PlatformIO is recommended as the easiest way to compile and upload Arduino compatible firmware for emonTH. One of the big advantages of using PlatformIO is all libraries can be automatically downloaded. Arduino IDE can also be used but libraries must be manually installed. - -### Compile & Upload Firmware Using PlatformIO - -For a full guide and installing and using PlatformIO (including visual IDE) see ['Compiling' User Guide Section](https://guide.openenergymonitor.org/technical/compiling). Assuming platformIO is installed - -``` -$ git clone https://github.com/openenergymonitor/emonth2 -$ cd emonth2 -$ pio run -$ pio -t upload -``` - ## Development The emonTH 2.0 builds on the earlier emonTH v1.x: https://github.com/openenergymonitor/emonth.