forked from open-ag-tech/api-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/master'
- Loading branch information
Showing
1 changed file
with
13 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,13 @@ | ||
# api-spec | ||
The open API specification for exchanging data and operational control | ||
# API Specification | ||
This directory contains the various parts of the open API specification for exchanging data and operational control in indoor agricultural environments. | ||
|
||
The specification is divided into the following sub-sections to make it easier to follow... | ||
|
||
* **General** - contains all of the essential rules that need to be followed, including common concepts, common data structures, timestamp formats, error handling, and so on. | ||
* **Plan** - specifies the API for interacting with the basic concepts of a well-planned facility (compartments, zones, crop varieties, and so on) | ||
* **Lights** - specifies the API for interacting with lighting systems | ||
* **Air** - specifies the API for interacting with air control systems (heating, cooling, ventilation, humidity, and so on) | ||
* **Soil** - specifies the API for interacting with soil monitoring systems | ||
* **Roots** - specifies the API for interacting with root monitoring systems | ||
* **Reservoirs** - specifies the API for interacting with reservoir control systems | ||
* **Nutrients** - specifies the API for monitoring nutrients |