Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Renato Bonomini committed Nov 19, 2020
1 parent 3bb881a commit 63c4dba
Show file tree
Hide file tree
Showing 9 changed files with 2,034 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.pio
.vscode/.browse.c_cpp.db*
.vscode/c_cpp_properties.json
.vscode/launch.json
.vscode/ipch
7 changes: 7 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
// See http://go.microsoft.com/fwlink/?LinkId=827846
// for the documentation about the extensions.json format
"recommendations": [
"platformio.platformio-ide"
]
}
19 changes: 19 additions & 0 deletions git_rev_macro.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Ptyhon script to generate define macro statements used at compile time
# They rely on this folder being cloned from the repo, e.g. from https://github.com/renatobo/bonogps
# Author: Renato Bonomini

import subprocess

revision = (
subprocess.check_output(["git", "describe", "--tags", "--always", "--dirty"])
.strip()
.decode("utf-8")
)

repo = (
subprocess.check_output(["git", "config", "--get", "remote.origin.url"])
.strip()
.decode("utf-8")
.replace('.git','')
)
print("-DGIT_REV='\"%s\"' -DGIT_REPO='\"%s/releases/tag/%s\"'" % (revision,repo,revision.replace('-dirty','')))
39 changes: 39 additions & 0 deletions include/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

This directory is intended for project header files.

A header file is a file containing C declarations and macro definitions
to be shared between several project source files. You request the use of a
header file in your project source file (C, C++, etc) located in `src` folder
by including it, with the C preprocessing directive `#include'.

```src/main.c

#include "header.h"

int main (void)
{
...
}
```

Including a header file produces the same results as copying the header file
into each source file that needs it. Such copying would be time-consuming
and error-prone. With a header file, the related declarations appear
in only one place. If they need to be changed, they can be changed in one
place, and programs that include the header file will automatically use the
new version when next recompiled. The header file eliminates the labor of
finding and changing all the copies as well as the risk that a failure to
find one copy will result in inconsistencies within a program.

In C, the usual convention is to give header files names that end with `.h'.
It is most portable to use only letters, digits, dashes, and underscores in
header file names, and at most one dot.

Read more about using header files in official GCC documentation:

* Include Syntax
* Include Operation
* Once-Only Headers
* Computed Includes

https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
46 changes: 46 additions & 0 deletions lib/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@

This directory is intended for project specific (private) libraries.
PlatformIO will compile them to static libraries and link into executable file.

The source code of each library should be placed in a an own separate directory
("lib/your_library_name/[here are source files]").

For example, see a structure of the following two libraries `Foo` and `Bar`:

|--lib
| |
| |--Bar
| | |--docs
| | |--examples
| | |--src
| | |- Bar.c
| | |- Bar.h
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
| |
| |--Foo
| | |- Foo.c
| | |- Foo.h
| |
| |- README --> THIS FILE
|
|- platformio.ini
|--src
|- main.c

and a contents of `src/main.c`:
```
#include <Foo.h>
#include <Bar.h>

int main (void)
{
...
}

```

PlatformIO Library Dependency Finder will find automatically dependent
libraries scanning project source files.

More information about PlatformIO Library Dependency Finder
- https://docs.platformio.org/page/librarymanager/ldf.html
6 changes: 6 additions & 0 deletions min_spiffs.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Name, Type, SubType, Offset, Size, Flags
nvs, data, nvs, 0x9000, 0x5000,
otadata, data, ota, 0xe000, 0x2000,
app0, app, ota_0, 0x10000, 0x1E0000,
app1, app, ota_1, 0x1F0000,0x1E0000,
spiffs, data, spiffs, 0x3D0000,0x30000,
58 changes: 58 additions & 0 deletions platformio.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
; PlatformIO Project Configuration File
;
; Build options: build flags, source filter
; Upload options: custom upload port, speed and extra flags
; Library options: dependencies, extra library storages
; Advanced options: extra scripting
;
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html

[platformio]
description = GPS module for GPS mobile apps used on track to time laps

[env]
platform = espressif32
board = esp32dev
; https://docs.platformio.org/en/latest/boards/espressif32/esp32dev.html#board-espressif32-esp32dev
framework = arduino
lib_deps =
h2zero/NimBLE-Arduino@^1.0.2
yiannisbourkelis/Uptime Library @ ^1.0.0
evert-arias/EasyButton @ ^2.0.1
arkhipenko/TaskScheduler @ ^3.2.0
https://github.com/tzapu/WiFiManager.git#development
board_build.partitions = min_spiffs.csv
monitor_speed = 115200
monitor_port = /dev/cu.SLAB_USBtoUART
monitor_filters = colorize, esp32_exception_decoder
upload_port = /dev/cu.SLAB_USBtoUART
build_flags = !python git_rev_macro.py

[env:debug]
build_type = debug
; option below need to be multi-line otherwise platformio does not consider them - perhaps a defect in how they are defined, not sure
build_flags =
${env.build_flags}
-D LOG_LOCAL_LEVEL=ESP_LOG_DEBUG
-D CORE_DEBUG_LEVEL=4
-D OTA_AVAILABLE=-1
-D BUILD_ENV_NAME='"test build"'

[env:release]
; option below need to be multi-line otherwise platformio does not consider them - perhaps a defect in how they are defined, not sure
build_flags =
${env.build_flags}
-D LOG_LOCAL_LEVEL=ESP_LOG_NONE
-D CORE_DEBUG_LEVEL=0
-D BUILD_ENV_NAME='"production build"'

[ota]
upload_protocol = espota
upload_port = bonogps.local

[env:debug_ota]
extends = env:debug, ota

[env:release_ota]
extends = env:release, ota
Loading

0 comments on commit 63c4dba

Please sign in to comment.