mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 01:06:52 +00:00
Doc update for SpaceAPI support for v15 of that API (#38524)
* Show removed configurations and add a missing config * Updates for the documentation standards * Fixed quotation placement in description * Quote all areas that use italics * default boolean * tiny tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
parent
c150c62dc7
commit
4e9944a982
@ -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 %}
|
||||
|
||||
@ -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
|
||||
@ -135,8 +153,8 @@ 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.
|
||||
@ -144,7 +162,7 @@ state:
|
||||
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:
|
||||
@ -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:
|
||||
@ -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:
|
||||
@ -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
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user