Skip to content

Commit

Permalink
improved installation section
Browse files Browse the repository at this point in the history
  • Loading branch information
hpsaturn committed Jan 14, 2024
1 parent 8658fd7 commit 143ca9a
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# M5StickC DCF77 HAT

Basic hat implementation of a DCF77 receiver for M5StickC-Plus or compatible ESP32 devices. This firmware uses a improvement of Arduino-DCF77 library, it is using events callback to improve the GUI and signal representation.
Basic hat implementation of a DCF77 receiver on a M5StickC-Plus or compatible ESP32 devices. This firmware uses an [improvement of Arduino-DCF77 library](https://github.com/hpsaturn/Arduino-DCF77), using an event callback to improve the GUI and signal representation.

<table>
<tr>
Expand All @@ -14,7 +14,7 @@ Basic hat implementation of a DCF77 receiver for M5StickC-Plus or compatible ESP

## Device

The current firmware was tested on 77.5KHZ single frequency device. It is the 4 pins version and it was bought here in [Aliexpress](https://www.aliexpress.com/item/1005005254051736.html).
The current firmware was tested on 77.5KHZ single frequency device. It is the 4 pins version and it was bought in [Aliexpress](https://www.aliexpress.com/item/1005005254051736.html).

## Wiring

Expand All @@ -31,17 +31,27 @@ The current firmware was tested on 77.5KHZ single frequency device. It is the 4

**Some tips:**

- [x] check the right device. Some devices has different frequencies for each country.
- [x] Try to remove the device from any radio or wireless intereference or noise. The radio is very susceptible to noise.
- [x] In indoors works, but is possible that in some builds doesn't. Try in outdoors first
- [x] the position of the device for me was important, in horizontal is possible that it works better
- [x] Check the right device. Some devices has different frequencies for each country.
- [x] Try to leave the device from away any radio or wireless interference or noise. The radio is very susceptible to noise.
- [x] In indoors it works, but is possible that in some builds doesn't. Try in outdoors first.
- [x] The position of the device for me was important, in horizontal is possible that it works better

**Buttons:**

- Left button: Power ON/Off
- M5 Button: Backlight or brightness toggle
- Right button: Unimplementened

## Installation

Please install first [PlatformIO](http://platformio.org/) open source ecosystem for IoT development compatible with **Arduino** IDE and its command line tools (Windows, MacOs and Linux). Also, you may need to install [git](http://git-scm.com/) in your system.

For the **default** board, the `M5StickCPlus`, only clone this and upload firmware via USB cable with a simple command:

`pio run --target upload`

or import the project in VSCode and build and run it.

## Box

Is a basic box - hat for these devices, for example M5StickC or M5StickC-Plus, also should be work in M5CoreInk device.
Expand All @@ -57,7 +67,9 @@ Also in [Thingiverse](https://www.thingiverse.com/thing:6033436).

---

## Credits
## Thanks to

https://github.com/thijse/Arduino-DCF77 (Old library)
https://www.seikowatches.com/instructions/html/SEIKO_8B92_EN/CWVVSYxxhbpilh
@felmue to fix a sporadical crash.
@jcomas for the help and docs on https://t.me/esp_es
The old [DCF77 library](https://github.com/thijse/Arduino-DCF77)
The [Seiko documentation](https://www.seikowatches.com/instructions/html/SEIKO_8B92_EN/CWVVSYxxhbpilh)

0 comments on commit 143ca9a

Please sign in to comment.