Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/almond-hydroponics/almond-controller
Project almond hardware esp8266 control code for hydroponics system
https://github.com/almond-hydroponics/almond-controller
almond cpp esp8266 hydroponics iot mqtt
Last synced: 13 days ago
JSON representation
Project almond hardware esp8266 control code for hydroponics system
- Host: GitHub
- URL: https://github.com/almond-hydroponics/almond-controller
- Owner: almond-hydroponics
- License: mit
- Created: 2020-07-03T15:01:37.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2021-11-26T21:37:50.000Z (about 3 years ago)
- Last Synced: 2024-11-14T23:32:25.916Z (2 months ago)
- Topics: almond, cpp, esp8266, hydroponics, iot, mqtt
- Language: C++
- Size: 6.65 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: .github/README.md
- License: LICENSE
Awesome Lists containing this project
README
## Almond Controller
Project almond hardware esp8266 control code for hydroponics system
[](https://almond.com)
#### Simple but complicated almond
### Description
This is a hydroponics farm control system to be used at home with limited space, in greenhouses and indoors as well.
### Getting started
1. Install relevant compilers for your OS:
- Windows: Visual Studio 2017 Community Edition x64 (this version is mandatory!)
- macOS: XCode
2. Install [`PlatformIO`](https://docs.platformio.org/en/latest/ide/vscode.html#ide-vscode) and set up on VSCode.
3. Clone this repository and the necessary submodules:
```
git clone https://github.com/almond-hydroponics/almond-controller.git
git submodule update --init https://github.com/adafruit/RTClib.git
```
### Development set up
1. Install [`PlatformIO`](https://docs.platformio.org/en/latest/ide/vscode.html#ide-vscode) and set up on VSCode.
2. To clone, run `https://github.com/almond-hydroponics/almond-controller.git`.
3. `cd` into the root of the **project directory**.
4. Upload the file from src to the esp32 board by using `platformio run`
### ESP 8266 Datasheet
[Datasheet Download](https://circuits4you.com/wp-content/uploads/2018/12/esp32-wroom-32_datasheet_en.pdf)
### ESP 8266 Pinout
### Testing
**Unit tests** - Run `platformio test -e nodemcuv2 -v` on the terminal while within the **project root directory**. Unit testing is achieved through the use of `platformio`.
### Support or Contribution
For any suggestions or contributions please do not hesitate to contact the owners of this repository.
Contributions to this project are welcomed by all, If you need to contribute, follow the steps below
- **Fork** the repository
- Follow [Installation and Setup](#installation) as explained earlier
- Create a branch off `develop` for the feature you wish to add
- Make necessary changes, commit and raise a pull request against develop, conventions can be found on the [wiki page](https://github.com/mashafrancis/almond-hw/wiki).
**Note** when making contributions, please endeavour to follow the [CppCoreGuidelines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md) C++ and Arduino style guide. Also make sure to follow the [Almond Guide](https://github.com/mashafrancis/almond-hw/wiki) for conventions.
### FAQ
See the almond [wiki](https://github.com/mashafrancis/almond-hw/wiki)