Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,57 @@ amplifytools.xcconfig
.secret-*
**.sample
#amplify-do-not-edit-end

# -- PlatformIO

fw/platformio/.pio
fw/platformio/.vscode/.browse.c_cpp.db*
fw/platformio/.vscode/c_cpp_properties.json
fw/platformio/.vscode/launch.json
fw/platformio/.vscode/ipch

# -- MacOS

*.log
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

# -- VSCode

.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets

# Local History for Visual Studio Code
.history/

# Built Visual Studio Code Extensions
*.vsix
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ SquidRID is a experimental tool to test and control most of aspects of the FAA R

The configurator is accessible at [https://squidrid.flyandi.net](https://squidrid.flyandi.net) but requires Google Chrome.

SquidRID run's on most ESP32 boards and requires the Arduino IDE to upload the firmware.
SquidRID run's on most ESP32 boards. Firmware can be compiled and uploaded using either:
* The Arduino IDE
* Open `fw/squidrid/squidrid.ino` in the Arudino IDE.
* PlatformIO + Visual Studio Code.
* Open the project by running `code fw/platformio`
* See [fw/platformio/README.md](fw/platformio/README.md) for more details.

## Features
```
Expand Down
10 changes: 10 additions & 0 deletions fw/platformio/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
// See http://go.microsoft.com/fwlink/?LinkId=827846
// for the documentation about the extensions.json format
"recommendations": [
"platformio.platformio-ide"
],
"unwantedRecommendations": [
"ms-vscode.cpptools-extension-pack"
]
}
10 changes: 10 additions & 0 deletions fw/platformio/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# About

This folder contains a [PlatformIO](https://platformio.org/platformio-ide) project to compile the Arduino firmware files in `fw/squidrid` (`./src` is a symbolic link to `../fw/squidrid`).

PlatformIO is a new generation toolset for embedded C/C++ development as a [VSCode](https://code.visualstudio.com/) extension.

# Configuration

This PlatformIO project is currently configured for a `featheresp32` board in the `arduino` environment. Specifically, I am using [Adafruit Huzzah32 Featherboard](https://www.adafruit.com/product/3405), but any ESP32 board should do. Just change configuration in PlatformIO extension (see `platformio.ini`).

3 changes: 3 additions & 0 deletions fw/platformio/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Remote ID Technical Specs

For the FAA provides specs via PDF Designation F3411 for free. View the [F3411.40165 PDF file here](https://mobile.reginfo.gov/public/do/eoDownloadDocument?pubId=&eodoc=true&documentID=7280). If the link above is dead, search for "FAA F3411"
39 changes: 39 additions & 0 deletions fw/platformio/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 fw/platformio/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
20 changes: 20 additions & 0 deletions fw/platformio/platformio.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
; 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

[env:featheresp32]
platform = espressif32
board = featheresp32
framework = arduino
lib_deps =
WiFi
plerup/EspSoftwareSerial@^8.1.0
build_flags = -DCORE_DEBUG_LEVEL=5
monitor_speed = 115200
monitor_filters = time
1 change: 1 addition & 0 deletions fw/platformio/src
11 changes: 11 additions & 0 deletions fw/platformio/test/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

This directory is intended for PlatformIO Test Runner and project tests.

Unit Testing is a software testing method by which individual units of
source code, sets of one or more MCU program modules together with associated
control data, usage procedures, and operating procedures, are tested to
determine whether they are fit for use. Unit testing finds problems early
in the development cycle.

More information about PlatformIO Unit Testing:
- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html