Space API
The spaceapi
integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allow Hackerspaces and Makerspaces to expose information to web apps or any other application with the SpaceAPI
Configuration
To configure connectivity and authentication to the API that this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] exposes, refer to the HTTP integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] documentation.
To setup the spaceapi
integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] in your installation, add the following to your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file.
After changing the configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes.
# 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
Location of the Hackerspace.
A flag indicating if the hackerspace uses SpaceFED, a federated login scheme so that visiting hackers can use the space Wi-Fi with their home space credentials.
Contact information of the Hackerspace. At least one entry is mandatory.
Persons who carry a key and are able to open the space upon request. One of the fields must be specified.
Contact the person with this nickname directly in irc if available. The irc channel to be used is defined in the contact/irc field.
Removed. V15 of SpaceAPI no longer supports this. The reporting channel for issues. Valid values are email
, issue_mail
, twitter
or ml
The current state of the Hackerspace.
The entity_id
of a binary sensor that represents whether the space is currently open or closed. If the binary sensor is unavailable, the state provided will be false.
The URL which is publicly accessible of the icon for the open Hackerspace.
Feeds where users can get updates of your space.
The blog of your Hackerspace.
The wiki of your Hackerspace.
The calendar of your Hackerspace.
Removed. V15 of SpaceAPI no longer supports this. Specifies options about caching of your SpaceAPI endpoint. Use this if you want to avoid hundreds/thousands of application instances crawling your status.
Your project sites (links to GitHub, wikis or wherever your projects are hosted).
Removed. V15 of SpaceAPI no longer supports this. A list of radio shows that your hackerspace might broadcast.
Although SpaceAPI supports many other sensors, this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] only supports temperature or humidity.
Examples
In this section you find some real-life examples of how to use this integration.
Eastermundigen
A possible configuration entry for Eastermundigen
# 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: "info@eastermundigen.ch"
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"