SpaceAPI


The spaceapi integration allow Hackerspaces to expose information to web apps or any other application with the SpaceAPI.

Configuration

To setup the spaceapi integration in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
spaceapi:
  space: HACKERSPACE_NAME
  logo: URL_FOR_LOGO
  url: URL
  location:
    address: ADDRESS
  contact:
    email: EMAIL_ADDRESS
  issue_report_channels:
    - email
  state:
    entity_id: binary_sensor.front_door

Configuration Variables

space

(string)(Required)

Name of the Hackerspace.

logo

(string)(Required)

URL of the hackerspace’s web site.

location

(map)(Required)

Location of the Hackerspace.

address

(string)(Required)

The physical address of the Hackerspace.

contact

(map)(Required)

Contact information of the Hackerspace.

email

(string)(Required)

The email address of the Hackerspace.

irc

(string)(Optional)

The IRC channel of the Hackerspace

mailing_list

(string)(Optional)

The mailing list of the Hackerspace.

twitter

(string)(Optional)

The Twitter account of the Hackerspace.

issue_report_channels

(list)(Required)

The reporting channel for issues. Pick an entity from contact:.

state

(list)(Required)

The current state of the Hackerspace.

entity_id

(string)(Required)

The entity_id of a binary sensor that represents the current state.

icon_open

(string)(Optional)

The URL which is publicly accessible of the icon for the open Hackerspace.

icon_closed

(string)(Optional)

The URL which is publicly accessible of the icon for the closed Hackerspace.

sensors

(list)(Optional)

List of sensors to expose.

temperature

(string)(Required)

List of temperature sensors.

humidity

(string)(Required)

List of humidity sensors.

The list of sensors can be any sensor, not just temperature or humidity.

Sensor specific location

The SpaceAPI specification requires every sensor to provide a location. In order to set a sensor specific location do the following steps:

  1. Go to Configuration -> Customization
  2. Select the sensor entity
  3. Pick “Other” from the attribute override pulldown
  4. Set the attribute name to location and the attribute value to your desired location

If no location is set, the location defined in the HA config is used.

Examples

In this section you find some real-life examples of how to use this component.

Eastermundigen

A possible configuration entry for Eastermundigen, a Hackerspace in Switzerland, could look like this.

# Example configuration.yaml entry
spaceapi:
  space: Eastermundigen
  logo: https://eastermundigen.ch/logo.png
  url: https://eastermundigen.ch
  location:
    address: "Steinbruchweg 16, 3072 Ostermundigen, Schweiz"
  contact:
    phone: "+41311111111"
    twitter: "@eastermundigen"
    email: "[email protected]"
  issue_report_channels:
    - email
  state:
    entity_id: binary_sensor.front_door"
    icon_open: https://eastermundigen.ch/open.png
    icon_closed: https://eastermundigen.ch/close.png
  sensors:
    temperature:
      - "sensor.temperature_in"
      - "sensor.temperature_out"
    humidity:
      - "sensor.humidity_in"
      - "sensor.humidity_out"