add readme

This commit is contained in:
andreas 2021-10-15 21:20:13 +02:00
parent 7e1b9a6ce6
commit e36d45e89f
1 changed files with 25 additions and 0 deletions

25
Readme.md Normal file
View File

@ -0,0 +1,25 @@
NMEA2000-Gateway with ESP32
===========================
Based on the work of [Homberger](https://github.com/AK-Homberger/NMEA2000WifiGateway-with-ESP32) - many thanks...
Goal
----
Have a simple ready-to-go ESP32 binary that can be flashed onto a [M5 Atom CAN](https://docs.m5stack.com/en/atom/atom_can), potentially extended by an [Atom Tail485](https://shop.m5stack.com/collections/atom-series/products/atom-tail485?variant=32169041559642) for NMEA0183 connection and power supply
Modes
-----
NMEA2000 -> Wifi (NMEA0183)
NMEA0183 -> Wifi
NMEA0183 -> NMEA2000
Wifi (NMEA0183) -> NMEA2000
....
Environment
-----------
[PlatformIO](https://platformio.org/).
Should be possible to use [M5Burner](https://docs.m5stack.com/en/download) to flash ready binaries.