Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| aa18076fe8 |
78
README.md
78
README.md
@@ -1,3 +1,79 @@
|
|||||||
# PlantBox
|
# PlantBox
|
||||||
|
|
||||||
> TODO
|
[](https://github.com/eveldee0680/PlantBox/blob/master/LICENSE)
|
||||||
|
[](https://github.com/eveldee0680/PlantBox/issues)
|
||||||
|
|
||||||
|
PlantBox allow people to manage plants in a new way,
|
||||||
|
it responds to the following problems:
|
||||||
|
|
||||||
|
- You lack of time
|
||||||
|
- You are absent
|
||||||
|
- You have lot of plants
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
PlantBox is a school project which goal is to create a solution to plant management.
|
||||||
|
It contains two parts:
|
||||||
|
|
||||||
|
- A server which collect information and manage the plant
|
||||||
|
- A client that display the evolution of the plant or alert user when needed
|
||||||
|
|
||||||
|
Client app is written in C# with .Net Standard, .Net Core and Xamarin.
|
||||||
|
Server is written in Python with the help of [grove.py][grove.py].
|
||||||
|
|
||||||
|
### Server
|
||||||
|
|
||||||
|
The server is a Raspberry Pi with appropriates captors:
|
||||||
|
|
||||||
|
- Humidity sensor
|
||||||
|
- Light sensor
|
||||||
|
- Temperature sensor
|
||||||
|
|
||||||
|
> See the [wiki](https://eveldee.ddns.net:1342/Eveldee/PlantBox/wiki/Server) page for more information
|
||||||
|
|
||||||
|
All input is read using [grove.py][grove.py].
|
||||||
|
|
||||||
|
### Client
|
||||||
|
|
||||||
|
The client is a mobile application made with [Xamarin.Forms](https://github.com/xamarin/Xamarin.Forms) for Android, iOS and UWP.
|
||||||
|
It uses [Microcharts](https://github.com/aloisdeniel/Microcharts) to display graphics.
|
||||||
|
|
||||||
|
> See the [wiki](https://eveldee.ddns.net:1342/Eveldee/PlantBox/wiki/Client) page for more information
|
||||||
|
|
||||||
|
### Protocol
|
||||||
|
|
||||||
|
Communication between the Server and the Client is made possible by using a strict
|
||||||
|
protocol.
|
||||||
|
> See the [wiki](https://eveldee.ddns.net:1342/Eveldee/PlantBox/wiki/Protocol) page for more information
|
||||||
|
|
||||||
|
## Current progress
|
||||||
|
|
||||||
|
> TODO
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
Features that will be implemented still need to be decided, but here is a potential list:
|
||||||
|
|
||||||
|
- Water the plant
|
||||||
|
- Check light level
|
||||||
|
- Check temperature
|
||||||
|
- Alert user when needed
|
||||||
|
- Display plant evolution on graphics
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
See the [Wiki](https://eveldee.ddns.net:1342/Eveldee/PlantBox/wiki) pages
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Contributions are disabled for the moment, see [Current progress](#current-progress)
|
||||||
|
|
||||||
|
## Copyright and licence
|
||||||
|
|
||||||
|
*PlantBox* is licensed under the [Mit Licence](https://github.com/eveldee0680/PlantBox/blob/master/LICENSE)
|
||||||
|
|
||||||
|
*grove.py* is licensed under the [Mit Licence](https://github.com/Seeed-Studio/grove.py/blob/master/LICENSE)
|
||||||
|
|
||||||
|
*Microcharts* is licensed under the [Mit licence](https://github.com/aloisdeniel/Microcharts/blob/master/LICENSE)
|
||||||
|
|
||||||
|
[grove.py]: https://github.com/Seeed-Studio/grove.py
|
||||||
Reference in New Issue
Block a user