-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from renatobo/feature/battery_ble
Feature/battery ble
- Loading branch information
Showing
14 changed files
with
502 additions
and
406 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,18 @@ | ||
|
|
||
| # Include files | ||
|
|
||
| [include/bonogps_board_settings.h](include/bonogps_board_settings.h) includes board settings (PINS mostly) that are specific to a tested board. | ||
| - [include/bonogps_board_settings.h](bonogps_board_settings.h) includes board settings (PINS mostly) that are specific to a tested board. | ||
|
|
||
| ## Generated files | ||
|
|
||
| These header files are generated so you should not manually modify them. Regenerate them with [generate_css.sh](../generate_css.sh) | ||
|
|
||
| - [include/bonogps_css_base.h](bonogps_css_base.h) preprocessing macro that defines the strings returned by the `http://bonogps.local/css` url in the portal | ||
| - [include/bonogps_css_base_battery.h](bonogps_css_base_battery.h) preprocessing macro that defines the strings returned by the `http://bonogps.local/css` url in the portal with additional definitions to show the battery (no need to increase the flash size if you don't need a battery gauge). This is used when macro `SHOWBATTERY` is used | ||
|
|
||
| ## Source files | ||
|
|
||
| Apply your customizations to CSS files here in their native format: they are minimized when imported in the source code. | ||
|
|
||
| - [include/style_base.css](style_base.css) CSS definitions for the web portal | ||
| - [include/style_base_battery.css](style_base_battery.css) CSS definitions required to display the battery gauge in the web portal |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,130 +1,7 @@ | ||
| # Software development and build | ||
| # Documentation on Software | ||
|
|
||
| - [IDE options/suggestions: Arduino IDE or VS Code+Platformio](#ide-optionssuggestions-arduino-ide-or-vs-codeplatformio) | ||
| - [Arduino IDE (recommended if you are new to the 'maker' approach)](#arduino-ide-recommended-if-you-are-new-to-the-maker-approach) | ||
| - [PlatformIO](#platformio) | ||
| - [Libraries](#libraries) | ||
| - [External Libraries](#external-libraries) | ||
| - [Optional external libraries](#optional-external-libraries) | ||
| - [Built-in libraries](#built-in-libraries) | ||
| - [Build options](#build-options) | ||
| - [Large use of preprocessing macro](#large-use-of-preprocessing-macro) | ||
| - [Logging facilities](#logging-facilities) | ||
| - [How to enable OTA build](#how-to-enable-ota-build) | ||
| - [OTA on Arduino IDE](#ota-on-arduino-ide) | ||
| - [OTA on PlatformIO](#ota-on-platformio) | ||
| - [Important: Partition size](#important-partition-size) | ||
| How to develop/build/upload the source code in [building](building) | ||
|
|
||
| ## IDE options/suggestions: Arduino IDE or VS Code+Platformio | ||
| How to connect your running bonogps device to a mobile app in [connecting](connecting) | ||
|
|
||
| Development is active on the [VS Code + Platformio](https://platformio.org/install/ide?install=vscode) combination: you can download the complete repository and work directly. | ||
|
|
||
| ### Arduino IDE (recommended if you are new to the 'maker' approach) | ||
|
|
||
| Code is written to be compatible with the Arduino IDE, there are a couple of steps required, starting from the assumption you have already installed and setup the Arduino IDE for ESP32 (if you have not, [here a nice tutorial](https://randomnerdtutorials.com/installing-the-esp32-board-in-arduino-ide-windows-instructions/)) | ||
|
|
||
| - install 'External libraries' listed below | ||
| - create an empty project | ||
| - copy the content of `src/bonogps.cpp` in the `.ino` file just created | ||
| - copy `include/bonogps_board_settings.h` in the same folder | ||
| - choose your board: "ESP32 Dev Module" (the generic board that everyone has, often tagged DOIT) or ["LOLIN D32 PRO" are supported](hardware/esp32/lolin_d32_pro.md), otherwise you might have to redefine your pins in `bonogps_board_settings.h` | ||
| - choose a partition schema with enough space (e.g. the Minimal SPIFSS with 1.9Mb of flash space) | ||
|
|
||
| The rest is common to any other build on the Arduino IDE. | ||
|
|
||
| IF you are unsure of what board you are running, [check this introductory tutorial](https://randomnerdtutorials.com/getting-started-with-esp32/). | ||
|
|
||
| You can update software OTA, check a later paragraph here on how as it's not enabled by default. | ||
|
|
||
| ### PlatformIO | ||
|
|
||
| Beside install PlatformIO (on VS Code as a recommendation), the build system uses a custom **python** script to determine the current software release version: `git_rev_macro.py` and it expects the project folder to be downloaded from github directly to build up the `GIT_REV` and `GIT_REPO` macro variables correctly. | ||
|
|
||
| If you are having issues, you can remove the line that invokes `git_rev_macro.py` and optionally set the 2 macro `GIT_REV` and `GIT_REPO` manually. | ||
|
|
||
| If you would like to define custom targets for your build, I recommend using a `platformio_custom.ini` file (there is a template in `platformio_custom.ini.template`). | ||
|
|
||
| ## Libraries | ||
|
|
||
| ### External Libraries | ||
|
|
||
| - [NimBLE-Arduino](https://github.com/h2zero/NimBLE-Arduino): 1.0.2 or better latest github version directly (default in platformio from v1.1 of bonogps) | ||
| - [Uptime Library](https://github.com/YiannisBourkelis/Uptime-Library) ^1.0.0 | ||
| - [EasyButton](https://easybtn.earias.me/) ^2.0.1 | ||
| - [Task Scheduler](https://github.com/arkhipenko/TaskScheduler) ^3.2.0 | ||
|
|
||
| From v1.1 of this code and using the latest code of NimBLE-Arduino (after this [commit](https://github.com/h2zero/NimBLE-Arduino/commit/569eb8a188c78fe780f4c2a24cf9247532cf55ea)), unnecessary BLE code is not compiled in. This reduces flash size by ~30kb of Nimble-Arduino disabling roles `CONFIG_BT_NIMBLE_ROLE_CENTRAL` and `CONFIG_BT_NIMBLE_ROLE_OBSERVER`. Up to version 1.0.2 of NimBLE-Arduino, you can manually uncomment those roles in `nimconfig.h` . | ||
|
|
||
| ### Optional external libraries | ||
|
|
||
| Included via `#define` options | ||
|
|
||
| - [NeoGPS](https://github.com/SlashDevin/NeoGPS) [not included right now, but coded and available for some additional cases] | ||
|
|
||
| ### Built-in libraries | ||
|
|
||
| Always included | ||
|
|
||
| - WebServer | ||
| - FS | ||
| - Preferences | ||
| - WiFi | ||
| - DNSServer | ||
| - ESPmDNS | ||
| - Update | ||
| - BluetoothSerial | ||
|
|
||
| Included via `#define` | ||
|
|
||
| - ArduinoOTA: this really depends on how you prefer to update software on your device. It adds size to the flash and it uses some memory, so if you don't plan on using it, don't include it. | ||
|
|
||
| ## Build options | ||
|
|
||
| ### Large use of preprocessing macro | ||
|
|
||
| To keep flash size small and to avoid several versions of the software, almost all features are enabled/disabled via macro preprocessing | ||
|
|
||
| For example, if you don't need BT-SPP or BLE, you can remove them. The most important ones are | ||
|
|
||
| - `BTSPPENABLED` Include BT-SPP capabilities (default: enabled) | ||
| - `BLEENABLED` Include BLE capabilities (default: enabled) | ||
| - `ENABLE_OTA` Include OTA capabilities (default: disabled) | ||
|
|
||
| ### Logging facilities | ||
|
|
||
| All logging on Serial Port is managed with `log_<i/d/e/w>()` functions (read more at [ESP32 Logging](https://thingpulse.com/esp32-logging/)). You can control how much logging is enabled within the Arduino IDE from the `Tools > Core Debug Level` menu. | ||
|
|
||
|  | ||
|
|
||
| ### How to enable OTA build | ||
|
|
||
| OTA libraries are not enabled by default, to keep the binary size smaller and to have less software running at all times (it's a miracle there are no RAM issues with all tasks running). | ||
|
|
||
| Since updating via OTA is extremely convenient when you are testing, here is how to activate it via two preprocessing macro variables | ||
|
|
||
| - `ENABLE_OTA` if defined, libraries and code is builtin, if undefined no OTA is included | ||
| - `OTA_AVAILABILITY_SECS` defines for how long OTA is available after boot, either `-1` (forever) or a finite number of seconds. If undefined, it's `300`, to avoid any mistake on the field where you might mistakenly start flashing a firmare you are actually using | ||
|
|
||
| #### OTA on Arduino IDE | ||
|
|
||
| - uncomment `// #define ENABLE_OTA` at the beginning of `src/bonogps.cpp` (which you might have renamed to `bonogps.ino`) | ||
| - optionally, change for how long OTA is available definining `OTA_AVAILABILITY_SECS` | ||
|
|
||
| #### OTA on PlatformIO | ||
|
|
||
| - There are a couple of build targets ending in `_ota` that contain the command line define statements. If you need more build targets, I recommend using a local `platformio_custom.ini` that is not sync'd with the git repository | ||
| - you can also permanently enable it changing the source code as for the Arduino case (not recommended) | ||
|
|
||
| ### Important: Partition size | ||
|
|
||
| You have to select a partitioning schema with 1.7 Mb of programming space (e.g. Minimal SPIFF with 1.9Mb), as the app with its libraries tend to be pretty large due to BT stacks. | ||
|
|
||
| Within PlatformIO, use the [platformio.ini](platformio.ini) available configuration | ||
|
|
||
| ```ini | ||
| board_build.partitions = min_spiffs.csv | ||
| ``` | ||
|
|
||
| Within the Arduino IDE, from `Tools > Partition Scheme` | ||
|
|
||
|  |
Oops, something went wrong.