Skip to content
This repository has been archived by the owner on Dec 30, 2019. It is now read-only.

Initial setup of firmware #7

Merged
merged 6 commits into from May 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/firmware/.gitignore
@@ -0,0 +1,3 @@
build/
.pioenvs
.piolibdeps
30 changes: 30 additions & 0 deletions packages/firmware/README.md
@@ -0,0 +1,30 @@
Galavanting Gnome Firmware
==========================
This project uses [Platform.IO][platform-io]. Follow it's [setup instructions][pio-setup] to get started.

Caveats
-------
I have not been able to program the leonardo or my uno without using an [USBTinyISP][usbtiny]. I have not been able to
get the normal usb programming working outside the Arduino IDE.

Building & Programming
----------------------
To build the firmware run the following command:

```bash
platformio run
```

You can specifiy a specific environment with the `-e` flag. Valid values are `leonardo` and `uno`.

To program the board run the following:

```bash
platformio run -e <BOARD> -t upload
```

If this gives you a verification error, you may need to use the `program` target before being able to use `upload`.

[platform-io]: https://platformio.org/
[pio-setup]: https://docs.platformio.org/en/latest/installation.html
[usbtiny]: https://www.adafruit.com/product/46
39 changes: 39 additions & 0 deletions packages/firmware/include/README
@@ -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 packages/firmware/lib/README
@@ -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
25 changes: 25 additions & 0 deletions packages/firmware/platformio.ini
@@ -0,0 +1,25 @@
; 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:leonardo]
platform = atmelavr
board = leonardo
framework = arduino
upload_protocol = usbtiny
lib_deps =
634

[env:uno]
platform = atmelavr
board = uno
framework = arduino
upload_protocol = usbtiny
lib_deps =
634
12 changes: 12 additions & 0 deletions packages/firmware/src/gnome.cpp
@@ -0,0 +1,12 @@
#include <Arduino.h>

void setup() {
pinMode(LED_BUILTIN, OUTPUT);
}

void loop() {
digitalWrite(LED_BUILTIN, HIGH);
delay(2000);
digitalWrite(LED_BUILTIN, LOW);
delay(4000);
}
11 changes: 11 additions & 0 deletions packages/firmware/test/README
@@ -0,0 +1,11 @@

This directory is intended for PIO Unit Testing 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 PIO Unit Testing:
- https://docs.platformio.org/page/plus/unit-testing.html