Skip to content

Commit

Permalink
Added awareness of the containing compartment to zones
Browse files Browse the repository at this point in the history
  • Loading branch information
jonginter committed Apr 24, 2018
1 parent 7e20275 commit 2cd85aa
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions versions/0.0.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,13 @@ A compartment is a physically isolated space within a facility for the purpose o
## Zone

A zone identifies an area within a compartment dedicated to maintaining a micro-climate. For example, a compartment would maintain uniform levels of humidity and air temperature, whereas a zone might alter the light levels or nutrient mix in the irrigation to create unique micro-climates.

Every zone contains zero or more zones and / or devices. Every device that is deployed should be assigned to the correct zone. Zones are a natural way of grouping devices for control purposes, so that a configuration can be pushed to a zone and affect all relevant devices within the zone at the same time.

All zones must be able to identify the crop variety they are overseeing. All data produced from a zone must include a crop variety ID for easy identification.

Each zone must be able to identify its size (in width and height) as well as its relative location within the compartment, since all sensors and controllers within that zone will report their location relative to the zone, not the compartment.

Zones can be combined into deep hierarchies. For example, a compartment can have multiple rows of plants that are 1 foot off the floor (e.g., lettuce), with an additional layer of plants 4 feet off the floor (e.g., strawberries). The grower would want to create unique zones for the lettuce vs. the strawberries, reflecting their unique feeds for irrigation and supplemental lighting. However, the grower would also want to maintain a general climate zone for the overall compartment for the purposes of controlling heating and ventilation. This means that the compartment would have a global zone containing two sub-zones.

## Location
Expand All @@ -52,6 +56,7 @@ Every device and zone should know its position relative to its container (device
## Device

A device refers to any physical mechanism that can either monitor or control the growing environment (lights, pumps, heaters, humidifiers, etc).

Every device must be related to a zone and a location within that zone. It should be able to report these relationships along with its own unique ID.

## Sensor
Expand Down Expand Up @@ -86,7 +91,8 @@ GET https://www.googleapis.com/books/v1/volumes/zyTCAlFPjgYC?key=yourAPIKey

# Error Handling

In principle, a successful API call should return an HTTP status code of 200. An unsuccessful API call will return an HTTP status code of 550 and the body should contain an error code that has been properly documented by the owner of the API.
In principle, a successful API call should return an HTTP status code of 200. An unsuccessful API call will return an HTTP status code of 550 and the body should contain an error code that has been properly documented by the owner of the API.

The interpretation of error codes, including the text describing the error, will be left up to the API user based on their understanding of the error code documentation provided by the API owner.

# Validation Handshake
Expand Down Expand Up @@ -126,12 +132,13 @@ http://[domain:port]/agroapi/[version]/zones/[zoneid]/location
| height | Height of the zone | cm |

#### Location
| Name | Description | Unit |
| ---- | ------------------------------------------- | ---- |
| zone | ID of the zone containing this zone, if any | uid |
| x | x coordinate of this device within the zone | cm |
| y | y coordinate of this device within the zone | cm |
| z | z coordinate of this device within the zone | cm |
| Name | Description | Unit |
| ----------- | ------------------------------------------- | ---- |
| compartment | ID of the compartment containing this zone | uid |
| zone | ID of the zone containing this zone, if any | uid |
| x | x coordinate of this zone within its parent | cm |
| y | y coordinate of this zone within its parent | cm |
| z | z coordinate of this zone within its parent | cm |

# Light
## Sensors
Expand Down

0 comments on commit 2cd85aa

Please sign in to comment.