Skip to content

Commit

Permalink
PlatformIO migration
Browse files Browse the repository at this point in the history
  * Codebase made PlatformIO compatible
  * Arduino plant-nutrition moved to a separate project
  • Loading branch information
vi7 committed Nov 15, 2019
1 parent a274580 commit 8083c76
Show file tree
Hide file tree
Showing 15 changed files with 308 additions and 180 deletions.
10 changes: 7 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# SublimeText
*.sublime-project
*.sublime-workspace
# vscode
.vscode

# macos
.DS_Store

# secrets
secrets.h

# PlatformIO
.pio
.pioenvs
.piolibdeps
67 changes: 67 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Continuous Integration (CI) is the practice, in software
# engineering, of merging all developer working copies with a shared mainline
# several times a day < https://docs.platformio.org/page/ci/index.html >
#
# Documentation:
#
# * Travis CI Embedded Builds with PlatformIO
# < https://docs.travis-ci.com/user/integration/platformio/ >
#
# * PlatformIO integration with Travis CI
# < https://docs.platformio.org/page/ci/travis.html >
#
# * User Guide for `platformio ci` command
# < https://docs.platformio.org/page/userguide/cmd_ci.html >
#
#
# Please choose one of the following templates (proposed below) and uncomment
# it (remove "# " before each line) or use own configuration according to the
# Travis CI documentation (see above).
#


#
# Template #1: General project. Test it using existing `platformio.ini`.
#

# language: python
# python:
# - "2.7"
#
# sudo: false
# cache:
# directories:
# - "~/.platformio"
#
# install:
# - pip install -U platformio
# - platformio update
#
# script:
# - platformio run


#
# Template #2: The project is intended to be used as a library with examples.
#

# language: python
# python:
# - "2.7"
#
# sudo: false
# cache:
# directories:
# - "~/.platformio"
#
# env:
# - PLATFORMIO_CI_SRC=path/to/test/file.c
# - PLATFORMIO_CI_SRC=examples/file.ino
# - PLATFORMIO_CI_SRC=path/to/test/directory
#
# install:
# - pip install -U platformio
# - platformio update
#
# script:
# - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
Environment manager for plant growing
=====================================


Temperature, relative humidity (RH) and power control
-----------------------------------------------------
=====================================================

Wemos D1 mini based remote controller/monitor

## Requirements

**Libraries**
**IDE and Libraries**

List of Arduino IDE libs
IDE: VSCode + [PlatformIO](http://platformio.org) IDE extension

- [ESP8266 board support](https://github.com/esp8266/Arduino#installing-with-boards-manager)
- [DHT sensor library for ESPx](https://github.com/beegee-tokyo/DHTesp)
Expand All @@ -23,13 +21,10 @@ List of Arduino IDE libs
- [Songle 230V relay switch](http://www.circuitbasics.com/wp-content/uploads/2015/11/5V-Relay-Pinout1.png)
- [Omron 230V 2 channel solid state relay](https://hobbycomponents.com/2362-thickbox_default/5v-2-channel-240v-ac-solid-state-relay.jpg)

## Setup

Drawn by hand schematic is [here](./resources/arduino-grower-schematic-by-hand.jpg). It'll be eventually replaced by something more professional in the future.
## Hardware configuration

---
Drawn by hand schematic is [here](resources/arduino-grower-schematic-by-hand.jpg). It'll be eventually replaced by something more professional in the future.

Plant nutrition
---------------
## Sofware configuration

Simple stupid watering solution. See further details in the project [README](plant-nutrition/README.md)
[client](client) dir contains web client for the built-in web server and docker-compose for launching the nginx ready for serving this client.
File renamed without changes.
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
File renamed without changes.
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
19 changes: 0 additions & 19 deletions plant-nutrition/README.md

This file was deleted.

108 changes: 0 additions & 108 deletions plant-nutrition/plant-nutrition.ino

This file was deleted.

15 changes: 15 additions & 0 deletions platformio.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
;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:d1_mini]
platform = espressif8266
board = d1_mini
framework = arduino

Binary file removed resources/plant-nutrition_connection_diagram.jpg
Binary file not shown.
Binary file removed resources/plant-nutrition_schematics.jpg
Binary file not shown.
Loading

0 comments on commit 8083c76

Please sign in to comment.