Skip to content

Doc update for SpaceAPI support for v15 of that API #38524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 14, 2025
Merged

Doc update for SpaceAPI support for v15 of that API #38524

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d5ab6de
Show removed configurations and add a missing config
fosterchuck Apr 13, 2025
c73362d
Updates for the documentation standards
fosterchuck Apr 13, 2025
bdd07d1
Fixed quotation placement in description
fosterchuck Apr 14, 2025
486d4eb
Quote all areas that use italics
fosterchuck Apr 14, 2025
a5c92d1
default boolean
fosterchuck Apr 14, 2025
86a0d60
tiny tweaks
c0ffeeca7 Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 25 additions & 7 deletions source/_integrations/spaceapi.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,16 @@ ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
- docs: /integrations/http/
title: HTTP integration
ha_quality_scale: legacy
---

The `spaceapi` {% term integration %} allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](https://spaceapi.io/).
The `spaceapi` {% term integration %} allow Hackerspaces and Makerspaces to expose information to web apps or any other application with the [SpaceAPI](https://spaceapi.io/). It does this by exposing an API on Home Assistant that hosts the JSON payload that SpaceAPI uses.

## Configuration

To configure connectivity and authentication to the API that this {% term integration %} exposes, refer to the HTTP {% term integration %} documentation.
To setup the `spaceapi` {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}

Expand Down Expand Up @@ -60,6 +63,21 @@ location:
description: The physical address of the Hackerspace.
required: true
type: string
spacefed:
description: 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.
required: false
type: map
keys:
spacenet:
description: Set to true or false depending on whether your space supports [spacenet](https://spacefed.net/index.php/Category:Howto/Spacenet)
required: true
type: boolean
default: false
spacesaml:
description: Set to true or false depending on whether your space uses [SpaceSAML](https://spacefed.net/index.php?title=Spacesaml)
required: true
type: boolean
default: false
contact:
description: Contact information of the Hackerspace. At least one entry is mandatory.
required: true
Expand Down Expand Up @@ -135,16 +153,16 @@ contact:
required: false
type: string
issue_report_channels:
description: "The reporting channel for issues. Valid values are `email`, `issue_mail`, `twitter` or `ml`"
required: true
description: "*Removed*. V15 of SpaceAPI no longer supports this. The reporting channel for issues. Valid values are `email`, `issue_mail`, `twitter` or `ml`"
required: false
type: list
state:
description: The current state of the Hackerspace.
required: true
type: list
keys:
entity_id:
description: "The `entity_id` of a binary sensor that represents the current state."
description: "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."
required: true
type: string
icon_open:
Expand Down Expand Up @@ -213,7 +231,7 @@ feeds:
required: true
type: string
cache:
description: Specifies options about caching of your SpaceAPI endpoint. Use this if you want to avoid hundreds/thousands of application instances crawling your status.
description: "*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."
required: false
type: map
keys:
Expand All @@ -226,7 +244,7 @@ projects:
required: false
type: list
radio_show:
description: A list of radio shows that your hackerspace might broadcast.
description: "*Removed*. V15 of SpaceAPI no longer supports this. A list of radio shows that your hackerspace might broadcast."
required: false
type: list
keys:
Expand Down Expand Up @@ -265,7 +283,7 @@ sensors:
type: string
{% endconfiguration %}

The list of sensors can be any sensor, not just temperature or humidity.
Although SpaceAPI supports many other sensors, this {% term integration %} only supports temperature or humidity.

## Examples

Expand Down