Skip to content

Commit dfb8059

Browse files
committed
README: Add repo overview.
1 parent 5e6cfea commit dfb8059

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

README.rst

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,70 @@ ESP32-Remote-Access
33

44
This repository contains everything needed to build and run the (**WIP**) remote access server for Tinkerforge WARP Chargers, WARP Energy Managers and ESP32-/ESP32-Ethernet-Bricks.
55

6+
Repository Overview
7+
-------------------
8+
9+
.. DO NOT EDIT THIS OVERVIEW MANUALLY! CHANGE https://github.com/Tinkerforge/esp32-firmware/repo_overview.rst AND COPY THAT BLOCK INTO ALL REPOS LISTED BELOW. TODO: AUTOMATE THIS
10+
11+
Software
12+
~~~~~~~~
13+
- `esp32-firmware <https://github.com/Tinkerforge/esp32-firmware>`__ **Please report any issues concerning WARP hard- and software here!** Source code of the ESP32 firmware shared between all WARP Chargers and Energy Managers
14+
15+
- `tfjson <https://github.com/Tinkerforge/tfjson>`__ SAX style JSON serializer and deserializer
16+
- `tfmodbustcp <https://github.com/Tinkerforge/tfmodbustcp>`__ Modbus TCP server and client implementation
17+
- `tfocpp <https://github.com/Tinkerforge/tfocpp>`__ OCPP 1.6 implementation
18+
- `tftools <https://github.com/Tinkerforge/tftools>`__ Miscellaneous tools and helpers
19+
20+
- `esp32-remote-access <https://github.com/Tinkerforge/esp32-remote-access>`__ Source code of the my.warp-charger.com remote access server
21+
22+
- `warp-charger <https://github.com/Tinkerforge/warp-charger>`__ The source code of (docs.)warp-charger.com and the printed manual, released firmwares, datasheets and documents, as well as some tools and hardware design files
23+
- `api.warp-charger.com <https://github.com/Tinkerforge/api.warp-charger.com>`__ Serves APIs that are used by WARP Chargers to obtain relevant public information like day ahead prices
24+
- `vislog.warp-charger.com <https://github.com/Tinkerforge/vislog.warp-charger.com>`__ Visualizes WARP Charger logs and EVSE debug protocols
25+
- `dbus-warp-charger <https://github.com/Tinkerforge/dbus-warp-charger>`__ Integrates WARP Chargers into a Victron Energy Venus OS device (e.g. Cerbo GX)
26+
27+
WARP Charger Hardware
28+
~~~~~~~~~~~~~~~~~~~~~~
29+
30+
- `esp32-brick <https://github.com/Tinkerforge/esp32-brick>`__ Hardware design files of the ESP32 Brick
31+
- `evse-bricklet <https://github.com/Tinkerforge/evse-bricklet>`__ Firmware source code and hardware design files of the EVSE Bricklet
32+
- `rs485-bricklet <https://github.com/Tinkerforge/rs485-bricklet>`__ Firmware source code and hardware design files of the RS485 Bricklet
33+
34+
WARP2 Charger Hardware
35+
~~~~~~~~~~~~~~~~~~~~~~
36+
37+
- `esp32-ethernet-brick <https://github.com/Tinkerforge/esp32-ethernet-brick>`__ Hardware design files of the ESP32 Ethernet Brick
38+
- `evse-v2-bricklet <https://github.com/Tinkerforge/evse-v2-bricklet>`__ Firmware source code and hardware design files of the EVSE 2.0 Bricklet
39+
- `nfc-bricklet <https://github.com/Tinkerforge/nfc-bricklet>`__ Firmware source code and hardware design files of the NFC Bricklet
40+
41+
WARP3 Charger Hardware
42+
~~~~~~~~~~~~~~~~~~~~~~
43+
44+
- `warp-esp32-ethernet-brick <https://github.com/Tinkerforge/warp-esp32-ethernet-brick>`__ Hardware design files of the WARP ESP32 Ethernet Brick
45+
- `evse-v3-bricklet <https://github.com/Tinkerforge/evse-v3-bricklet>`__ Firmware source code and hardware design files of the EVSE 3.0 Bricklet
46+
- `nfc-bricklet <https://github.com/Tinkerforge/nfc-bricklet>`__ Firmware source code and hardware design files of the NFC Bricklet
47+
48+
WARP Energy Manager Hardware
49+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50+
51+
- `esp32-ethernet-brick <https://github.com/Tinkerforge/esp32-ethernet-brick>`__ Hardware design files of the ESP32 Ethernet Brick
52+
- `warp-energy-manager-bricklet <https://github.com/Tinkerforge/warp-energy-manager-bricklet>`__ Firmware source code and hardware design files of the WARP Energy Manager Bricklet
53+
54+
WARP Energy Manager 2.0 Hardware
55+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56+
57+
- `esp32-ethernet-brick <https://github.com/Tinkerforge/esp32-ethernet-brick>`__ Hardware design files of the ESP32 Ethernet Brick
58+
- `warp-energy-manager-v2-bricklet <https://github.com/Tinkerforge/warp-energy-manager-v2-bricklet>`__ Firmware source code and hardware design files of the WARP Energy Manager 2.0 Bricklet
59+
- `warp-front-panel-bricklet <https://github.com/Tinkerforge/warp-front-panel-bricklet>`__ Firmware source code and hardware design files of the WARP Front Panel Bricklet
60+
61+
Forked/patched projects
62+
~~~~~~~~~~~~~~~~~~~~~~~
63+
64+
- `arduino-esp32 <https://github.com/Tinkerforge/arduino-esp32>`__
65+
- `esp32-arduino-libs <https://github.com/Tinkerforge/esp32-arduino-libs>`__
66+
- `WireGuard-ESP32-Arduino <https://github.com/Tinkerforge/WireGuard-ESP32-Arduino>`__
67+
68+
69+
670
File structure
771
--------------
872

0 commit comments

Comments
 (0)