Skip to content

Commit e912b8a

Browse files
committed
Add isotp-c as git submodule
1 parent 91de7f7 commit e912b8a

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "lib/isotp"]
2+
path = lib/isotp
3+
url = https://github.com/LibreSolar/isotp-c

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,23 @@ The data can be accessed in the same way as described above.
4040
- Data access via HTTP JSON API
4141
- Publishing of monitoring data via WiFi to
4242
- Open Energy Monitor [Emoncms](https://emoncms.org/)
43-
- MQTT sever (ToDo)
43+
- MQTT server (ToDo)
4444
- Data logging on SD card (ToDo)
4545

4646
## Usage
4747

48-
### Build the Webapp
48+
### Getting the firmware
49+
50+
This firmware repository contains git submodules, so you need to clone (download) it by calling:
51+
52+
```
53+
git clone --recursive https://github.com/LibreSolar/esp32-edge-firmware
54+
```
55+
56+
Unfortunately, the green GitHub "Clone or download" button does not include submodules. If you cloned the repository already and want to pull the submodules, run `git submodule update --init --recursive`.
57+
58+
59+
### Building the webapp
4960

5061
To be able to build the esp32-edge-firmware you need to build the webapp first.
5162
To do so, go into the webapp folder
@@ -59,7 +70,8 @@ and run
5970
npm install
6071
npm run build
6172
```
62-
you are now able to build the firmware itself.
73+
74+
You are now able to build the firmware itself.
6375

6476
### ESP-IDF toolchain
6577

@@ -72,7 +84,7 @@ After installation run the following commands:
7284

7385
### PlatformIO
7486

75-
You can use PlatformIO for easy bulding and flashing. Currently, ESP-IDF 4.0 support is still in beta phase, so it might not work out of the box. However, the setup in `platformio.ini` was adjusted to support the new ESP-IDF already.
87+
You can use PlatformIO for easy building and flashing. However, the PlatformIO packages for ESP-IDF are not updated as frequently as the official repositories.
7688

7789
### Configuration
7890

lib/isotp

Submodule isotp added at 9755e03

0 commit comments

Comments
 (0)