Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TrystanLea committed Feb 17, 2023
1 parent 62d53ff commit 4f65041
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 27 deletions.
2 changes: 1 addition & 1 deletion firmware/emonth2.ino
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
28 changes: 2 additions & 26 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 4f65041

Please sign in to comment.