Skip to content
fpomar edited this page Jul 13, 2016 · 19 revisions

Definition of the weather data API.

Zones

Zone basic info

/<zone_name>/
{
  "name": "[zone_name]",
  "first_state_time": "[iso_first_state_time]",
  "last_state_time": "[iso_last_state_time]"
  "config": {
      // ... Zone configuration ..
  }
}

Zone map

/<zone_name>/map_image.png

Map of zone geographical borders (PNG)

States

State basic info

/<zone_name>/<state_time>/
{
  "zone_name": "[state_zone_name]",
  "time": "[iso_state_time]",
  "prev_state_time": "[iso_prev_state_time]" | null,
  "next_state_time": "[iso_next_state_time]" | null,
  "datas": [
    {
      "satellite": "[data_satellite]",
      "channel": "[data_channel]"
    },
  ]
}

State static data

/<zone_name>/<state_time>/<satellite>/<channel>/image.png

Image of state sensor data for the providing satellite and channel (PNG)

Flow (by interval)

Flow state components

/<zone_name>/<start_state_time>/<end_state_time>/
[
    "state_time",
    "state_time",
    ...
]

Flow state trails image

/<zone_name>/<start_state_time>/<end_state_time>/trails.png

Rendered image of trails generated in flow (PNG)

Flow (by steps)

Flow state components

/<zone_name>/<end_state_time>/flow/<number_of_steps>
[
    "state_time",
    "state_time",
    ...
]

Flow state trails image

/<zone_name>/<end_state_time>/flow/<number_of_steps>/trails.png

Rendered image of trails generated in flow (PNG)