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 pull request open-ag-tech#6 from open-ag-tech/Light---Kelvin-an…
…d-POST-requests POST requests and CCT for white channels
- Loading branch information
Showing
17 changed files
with
1,911 additions
and
65 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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# 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 |
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 |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Purpose | ||
|
||
This specification is intended to define a standardized way of communicating with climate control systems for real-time monitoring and control of air quality and to allow data collection between control systems and / or peripheral devices. | ||
|
||
# Scope | ||
|
||
The scope of this document is limited to providing a payload structure and endpoint type definitions to allow basic control and data acquisition. The addition of product specific features is left to the implementer, but to be in compliance the product must support the basic set of features specified below. | ||
|
||
# Definitions | ||
|
||
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. | ||
|
||
# Endpoints | ||
## Sensors | ||
### URLS | ||
### Measurements | ||
| Data point | Description | Unit | | ||
| ---------- | -------------------------------- | ------- | | ||
| temp | The temperature of the air | celsius | | ||
| humidity | The level of humidity in the air | % | | ||
| co2 | The level of CO2 in the air | ppm | | ||
| airflow | The speed of the airflow | m3/s | |
Oops, something went wrong.