Skip to content

Commit

Permalink
OpenEEW Firmware
Browse files Browse the repository at this point in the history
Signed-off-by: John Walicki <johnwalicki@gmail.com>
  • Loading branch information
johnwalicki committed Mar 20, 2021
1 parent fb437fd commit 0884667
Show file tree
Hide file tree
Showing 71 changed files with 8 additions and 37,210 deletions.
40 changes: 8 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,31 @@
# OpenEEW Sensor
# OpenEEW Sensor Firmware
The OpenEEW sensor features a high performance MEMS accelerometer and Ethernet or WiFi connectivity. It includes also a loud buzzer and 3 bright Neopixel LEDS for alarm functions. By including alarm functions, the owners of the locations where they are installed are more likely to value and look after the device.

The OpenEEW sensor has already shown itself to be [as good as seismometers that cost 60x more](https://openeew.com/blog/sensor-benchmark).

## Hardware

Components are mounted in a PCB with the corresponding circuitry. The board operates at 3.3V with a maximum current of 1A. The accelerometer is accessed via SPI interface, specifically ESP32's HSPI. For this device we have selected the ADXL355 accelerometer for its low noise and relatively low cost.

The ethernet uses the LAN8720A transceiver. We have not included PoE in this varient to reduce complexity and cost, but this may be a good option for some.

GPS can optionally be added with a UART interface.

You can find the schematics, PCB, and BOM files in [here](/pcb). The board was generated using [Kicad](https://kicad-pcb.org/).

The assembled sensor, enclosure, and power supply, can also be bought directly [here](https://grillo.io/product/openeew-node/).

![PCB](images/openeew-node-board.jpg)

Please note the following pins:
- ADXL355 > SPI (HSPI) > CS GPIO 15
- Neopixel data pin> GPIO 16
- Buzzer > GPIO 32

## Enclosure

You can [3d print yourself a sturdy wall mounted enclosure](/enclosure/) for your PCB using the 3d files. This design features snap lip joints to make it easy to assemble, and flanged base for a sturdy connection to the wall surface. Here you can find a variant that includes a housing for a small [bubble level](https://www.aliexpress.com/item/33023021109.html?spm=a2g0o.productlist.0.0.40315dfczmp3OU&algo_pvid=bdb50c5f-6bba-4c9a-ac95-6905622008cf&algo_expid=bdb50c5f-6bba-4c9a-ac95-6905622008cf-27&btsid=0ab6fb8315990954564341733e9ba2&ws_ab_test=searchweb0_0,searchweb201602_,searchweb201603_) that will help with installation.

![3d printed case v1.0](/images/openeew-node-withlid.jpg)

![3d printed case v1.0](/images/openeew-node-blue.jpg)

![3d printed case v1.0](/images/animated-box.gif)


Alternatively you can buy a case that fits the board dimensions ([such as this](https://www.aliexpress.com/item/4000337012320.html?spm=a2g0o.detail.1000014.19.36fa34d16GPRAR&gps-id=pcDetailBottomMoreOtherSeller&scm=1007.14976.157518.0&scm_id=1007.14976.157518.0&scm-url=1007.14976.157518.0&pvid=d8255fa0-4728-41cd-be64-fe030910cf37&_t=gps-id:pcDetailBottomMoreOtherSeller,scm-url:1007.14976.157518.0,pvid:d8255fa0-4728-41cd-be64-fe030910cf37,tpp_buckets:668%230%23131923%2312_668%23808%236395%23432_668%23888%233325%233_4976%230%23157518%230_4976%232711%237538%23458_4976%233223%2310328%231_4976%233104%239653%235_4976%233141%239887%239_668%232846%238107%2326_668%232717%237564%23644_668%233164%239976%23121)), although it will require modifications to allow for ethernet and power jacks.

## Firmware
[This code](https://github.com/openeew/openeew-sensor/tree/master/firmware) allows an ESP32 device to send 3 axis accelerometer readings to a remote MQTT endpoint from its accelerometer to an MQTT endpoint. Optionally it also allows an attached NEO-6m GPS module to attach accurate time via the PPS signal (Pulse Per Second).

For more details please review the [firmware instructions](https://github.com/openeew/openeew-sensor/blob/master/firmware/README.md).
[This code](https://github.com/openeew/openeew-firmware/tree/master/) allows an ESP32 device to send 3 axis accelerometer readings to a remote MQTT endpoint from its accelerometer to an MQTT endpoint. Optionally it also allows an attached NEO-6m GPS module to attach accurate time via the PPS signal (Pulse Per Second).

For more details please review the [firmware instructions](https://github.com/openeew/openeew-firmware/blob/master/WatsonIoT/README.md).

Learn more about using [MQTT to communicate with the firmware](FIRMWARE.md)
Learn more about using [MQTT to communicate with the firmware](FIRMWARE.md)

### Contributors

<a href="https://github.com/openeew/openeew-sensor/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=openeew/openeew-sensor" />
<a href="https://github.com/openeew/openeew-firmware/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=openeew/openeew-firmware" />
</a>
___

Enjoy! Give us [feedback](https://github.com/openeew/openeew-sensor/issues) if you have suggestions on how to improve this information.
Enjoy! Give us [feedback](https://github.com/openeew/openeew-firmware/issues) if you have suggestions on how to improve this information.

## Contributing and Developer information

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file removed enclosure/openeew enclosure bottom.stl
Binary file not shown.
Binary file removed enclosure/openeew enclosure lid.stl
Binary file not shown.
25 changes: 0 additions & 25 deletions enclosure/readme.md

This file was deleted.

5 changes: 0 additions & 5 deletions firmware/.gitignore

This file was deleted.

67 changes: 0 additions & 67 deletions firmware/.travis.yml

This file was deleted.

7 changes: 0 additions & 7 deletions firmware/.vscode/extensions.json

This file was deleted.

Binary file removed images/PCB-3d.png
Binary file not shown.
Binary file removed images/animated-box.gif
Binary file not shown.
Binary file removed images/case-bottom.jpg
Binary file not shown.
Binary file removed images/case-lid.jpg
Binary file not shown.
Binary file removed images/openeew-node-blue.jpg
Binary file not shown.
Binary file removed images/openeew-node-withlid.jpg
Binary file not shown.
Binary file removed images/pcb-openeew.PNG
Binary file not shown.
Binary file removed images/sensor-bubble-level.jpg
Binary file not shown.
Binary file removed images/sensor-case-closed.jpg
Binary file not shown.
Binary file removed images/sensor-case-open.jpg
Binary file not shown.
Binary file removed images/sensor-install.jpg
Binary file not shown.
Binary file removed images/threaded-insert.jpg
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
7 changes: 0 additions & 7 deletions pcb/.gitignore

This file was deleted.

7 changes: 0 additions & 7 deletions pcb/fp-lib-table

This file was deleted.

Loading

0 comments on commit 0884667

Please sign in to comment.