openapiaryformat reference 0.1¶

This format creates a way for different independent projects and data sources to share their data of bees and apiaries. The format specifications and reference implementations for an easy start will be public available and open source.

You can get your version of this document at http://openapiaryformat-reference.readthedocs.org

Content¶

Description¶

This format describes a machine and human readable way to structure data related to apiaries and bees.

Goals¶

These goals describe the foundation of what we try to achieve. This will be a guideline to help us to refine upcoming iterations of this document and format. Take also a look at the Roadmap for the upcoming milestones.

Everything should be as human readable as possible without compromising machine-readability
The format can be used in a very lean way (short and simple) but should be powerfull enough to handle all cases.
The current state of the apiaries and hives is always easy avaialble and does not require computing or looking at history data

Roadmap¶

This should give a rough overview of the upcoming iterations and what to tackle next. This is of course subject to change.

0.1 - Basic attributes for apiaries and hives. names, locations, descriptions

0.2 - Add inspektions, treatments and weekly checks

0.3 - Track diseases (e.g.: mites)

0.4 - Improved hive management. Manufacturers of Boxes and Frames.

At this point we have a working basis for sharing and storing everyday beekeeping. The next items are more for science and technical projects.

0.5 - Sensors! How to store sensor data. Weight, Temperature, unknown data!

0.6 - Queen management. History and breeding of queens.

0.7 - ??

Reference¶

type¶

hive apiary link

name¶

description¶

identifier¶

location¶

latitude
longitude

Examples¶

Simple hive:

{
  "type" : "hive",
  "name" : "My Second Hive",
  "identifier": "a9d19090b1b7f675b50e06652fd0a8b7ff252945",
  "description" : "Watch your step",
}

Simple apiary:

{
  {
    "type": "apiary",
    "name": "My Apiary",
    "description" : "this is my apiary",
    "location" : {
      "latitude": 0.023,
      "longitude": 0.123
    },
    "hives":{
      {
        "type" : "link",
        "identifier": "a9d19090b1b7f675b50e06652fd0a8b7ff252945",
      },
    }
  }
}

{
  "name" : "My Second Hive"
  "type" : "hive"
  "description" : "Watch your step",
}

License¶

This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/.