mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-28 05:46:48 +00:00

* build(deps-dev): bump sorbet-runtime from 0.5.11549 to 0.5.11551 (#34487) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11549 to 0.5.11551. - [Release notes](https://github.com/sorbet/sorbet/releases) - [Commits](https://github.com/sorbet/sorbet/commits) --- updated-dependencies: - dependency-name: sorbet-runtime dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump google-protobuf from 4.27.4 to 4.28.0 (#34488) Bumps [google-protobuf](https://github.com/protocolbuffers/protobuf) from 4.27.4 to 4.28.0. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/main/protobuf_release.bzl) - [Commits](https://github.com/protocolbuffers/protobuf/commits) --- updated-dependencies: - dependency-name: google-protobuf dependency-type: indirect update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add limitations section to Enmax integration (#34493) Enmax Energy only publishes monthly data via Opower, make a note in the documentation * build(deps-dev): bump ruby-lsp from 0.17.16 to 0.17.17 (#34496) Bumps [ruby-lsp](https://github.com/Shopify/ruby-lsp) from 0.17.16 to 0.17.17. - [Release notes](https://github.com/Shopify/ruby-lsp/releases) - [Commits](https://github.com/Shopify/ruby-lsp/compare/v0.17.16...v0.17.17) --- updated-dependencies: - dependency-name: ruby-lsp dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump sorbet-runtime from 0.5.11551 to 0.5.11553 (#34497) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11551 to 0.5.11553. - [Release notes](https://github.com/sorbet/sorbet/releases) - [Commits](https://github.com/sorbet/sorbet/commits) --- updated-dependencies: - dependency-name: sorbet-runtime dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Locked out: add screencast of auth reset (#34499) * Locked out: add screencast of auth reset * Update steps to point to Green and Yellow reset procedures * Fix copy paste error * Update clip * Fix video to show standard port * Fix typo in "default sentences" documentation (#34528) * Add missing quote (#34519) Signed-off-by: Matthias Beyer <mail@beyermatthias.de> * Fix opentherm_gw gpio modes (#34501) * home connect: Update links for registering an app and logging out (#34508) * Update links for registering an app and logging out * Update link * Update source/_integrations/home_connect.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * tiny tweaks --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * build(deps-dev): bump rubocop from 1.65.1 to 1.66.0 (#34535) Bumps [rubocop](https://github.com/rubocop/rubocop) from 1.65.1 to 1.66.0. - [Release notes](https://github.com/rubocop/rubocop/releases) - [Changelog](https://github.com/rubocop/rubocop/blob/master/CHANGELOG.md) - [Commits](https://github.com/rubocop/rubocop/compare/v1.65.1...v1.66.0) --- updated-dependencies: - dependency-name: rubocop dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump logger from 1.6.0 to 1.6.1 (#34536) Bumps [logger](https://github.com/ruby/logger) from 1.6.0 to 1.6.1. - [Release notes](https://github.com/ruby/logger/releases) - [Commits](https://github.com/ruby/logger/compare/v1.6.0...v1.6.1) --- updated-dependencies: - dependency-name: logger dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * home connect: Add instructions for getting the client ID and secret (#34509) * home connect: Add instructions for getting the client ID and secret * Update home_connect.markdown * Update home_connect.markdown * tiny tweak --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Document prerequisites for Webmin integration (#34515) * Update webmin.markdown Add details about prerequisites (installing XML::Parser), add additional context for user account creation, update phrasing of existing content * Minor tweaks for verbiage, proper markdown * Additional readability improvements for Webmin * Fix odd wording in Webmin account benefits "allows for" might imply that a separate account is automatically more secure; switching to "can allow for" to instead imply that things can be made more granular if desired. * Update source/_integrations/webmin.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Tiny style tweaks --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * ubus.markdown: fix JSON syntax (#34522) * Update unifiprotect.markdown with information about event for doorbell (#34537) * Update unifiprotect.markdown with information about event for doorbell Add more information about the event entity when a doorbell is rang. * Tiny tweak --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Add Enphase_envoy prerequisites (#34539) * Add Enphase_envoy prerequisites * Implement review suggestions Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Remove links to custom integrations --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * build(deps-dev): bump rubocop-ast from 1.32.1 to 1.32.2 (#34547) Bumps [rubocop-ast](https://github.com/rubocop/rubocop-ast) from 1.32.1 to 1.32.2. - [Release notes](https://github.com/rubocop/rubocop-ast/releases) - [Changelog](https://github.com/rubocop/rubocop-ast/blob/master/CHANGELOG.md) - [Commits](https://github.com/rubocop/rubocop-ast/compare/v1.32.1...v1.32.2) --- updated-dependencies: - dependency-name: rubocop-ast dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Enable entity (#34550) * Enable a single entity from device page * Add related topic * Add term ref * Add missing step * Add some background info why entities are disabled by default * Rephrase * Fix typo * Fix typo in google_translate (#34552) * New WWHA blog upload (#34551) * New WWHA blog upload * Update source/_posts/2024-09-03-aqara-joins-works-with-home-assistant.markdown --------- Co-authored-by: Gord <31004434+googanhiem@users.noreply.github.com> * Split august and yale integrations (#33890) * Add yale integration This PR should not merge until the integration branch in https://github.com/home-assistant/core/pull/122253 is complete * Update source/_integrations/yale.markdown * Tiny tweaks * Apply suggestions from code review * review comments * Apply suggestions from code review * Update source/_integrations/yale.markdown * Update source/_integrations/yale.markdown * Apply suggestions from code review * Update source/_integrations/yale.markdown --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Simple Fin - Add Problem Sensor Documentation (#33979) * Adding the problems ensor * Tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Redirect virtual integration yale_home to point to yale (#34482) * Remove Yale (Assa Abloy) devices from the august integration docs (#34484) * Remove Yale (Assa Abloy) devices from the august integration docs The new yale integration should be used for these devices instead * Remove Assa Abloy note since August is now owned by FBIN * Change entity badge display type to 3 booleans : name, state and icon (#34503) * Remove KNX free-online-training paragraph (#34531) * build(deps-dev): bump sorbet-runtime from 0.5.11553 to 0.5.11554 (#34561) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11553 to 0.5.11554. - [Release notes](https://github.com/sorbet/sorbet/releases) - [Commits](https://github.com/sorbet/sorbet/commits) --- updated-dependencies: - dependency-name: sorbet-runtime dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump mustermann from 3.0.2 to 3.0.3 (#34562) Bumps [mustermann](https://github.com/sinatra/mustermann) from 3.0.2 to 3.0.3. - [Commits](https://github.com/sinatra/mustermann/compare/v3.0.2...v3.0.3) --- updated-dependencies: - dependency-name: mustermann dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump rexml from 3.3.6 to 3.3.7 (#34563) Bumps [rexml](https://github.com/ruby/rexml) from 3.3.6 to 3.3.7. - [Release notes](https://github.com/ruby/rexml/releases) - [Changelog](https://github.com/ruby/rexml/blob/master/NEWS.md) - [Commits](https://github.com/ruby/rexml/compare/v3.3.6...v3.3.7) --- updated-dependencies: - dependency-name: rexml dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump sass-embedded from 1.77.8 to 1.78.0 (#34564) Bumps [sass-embedded](https://github.com/sass-contrib/sass-embedded-host-ruby) from 1.77.8 to 1.78.0. - [Commits](https://github.com/sass-contrib/sass-embedded-host-ruby/compare/v1.77.8...v1.78.0) --- updated-dependencies: - dependency-name: sass-embedded dependency-type: indirect update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Event docs and integration: add related links (#34569) * State trigger: rephrase (#34571) * State trigger: rephrase * Add intro text to example * Light: add section on states (#34573) * Update release notes for 2024.9 * Update 2024-09-04-release-20249.markdown * Update 2024-09-04-release-20249.markdown * Update 2024-09-04-release-20249.markdown * Update 2024-09-04-release-20249.markdown * update images * address comments * Update 2024-09-04-release-20249.markdown * Apply suggestions from code review Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * suggestions * Apply suggestions from code review Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Matthias Beyer <mail@beyermatthias.de> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: iomartin <iomartin@users.noreply.github.com> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Co-authored-by: Stuart Holland <soulc3@gmail.com> Co-authored-by: Matthias Beyer <mail@beyermatthias.de> Co-authored-by: mvn23 <schopdiedwaas@gmail.com> Co-authored-by: Max R <mxr@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: kylehakala <kylehakala@users.noreply.github.com> Co-authored-by: René Kliment <rene@renekliment.cz> Co-authored-by: darkrain-nl <24763370+darkrain-nl@users.noreply.github.com> Co-authored-by: Arie Catsman <120491684+catsmanac@users.noreply.github.com> Co-authored-by: Luca Angemi <luca.angemi@gmail.com> Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> Co-authored-by: Gord <31004434+googanhiem@users.noreply.github.com> Co-authored-by: J. Nick Koston <nick@koston.org> Co-authored-by: Jeef <jeeftor@users.noreply.github.com> Co-authored-by: Paul Bottein <paul.bottein@gmail.com> Co-authored-by: Matthias Alphart <farmio@alphart.net>
303 lines
8.3 KiB
Markdown
303 lines
8.3 KiB
Markdown
---
|
|
title: Space API
|
|
description: Instructions on how to configure the SpaceAPI for Home Assistant.
|
|
ha_category:
|
|
- Social
|
|
ha_iot_class: Cloud Polling
|
|
ha_release: '0.70'
|
|
ha_codeowners:
|
|
- '@fabaff'
|
|
ha_domain: spaceapi
|
|
ha_integration_type: integration
|
|
related:
|
|
- docs: /docs/configuration/
|
|
title: Configuration file
|
|
---
|
|
|
|
The `spaceapi` {% term integration %} allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](https://spaceapi.io/).
|
|
|
|
## Configuration
|
|
|
|
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 %}
|
|
|
|
```yaml
|
|
# 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 %}
|
|
space:
|
|
description: Name of the Hackerspace.
|
|
required: true
|
|
type: string
|
|
logo:
|
|
description: URL which is publicly accessible of the logo.
|
|
required: true
|
|
type: string
|
|
url:
|
|
description: URL of the hackerspace's web site.
|
|
required: true
|
|
type: string
|
|
location:
|
|
description: Location of the Hackerspace.
|
|
required: false
|
|
type: map
|
|
keys:
|
|
address:
|
|
description: The physical address of the Hackerspace.
|
|
required: true
|
|
type: string
|
|
contact:
|
|
description: Contact information of the Hackerspace. At least one entry is mandatory.
|
|
required: true
|
|
type: map
|
|
keys:
|
|
phone:
|
|
description: The phone number of the Hackerspace.
|
|
required: false
|
|
type: string
|
|
sip:
|
|
description: The SIP URI for Voice-over-IP of the Hackerspace.
|
|
required: false
|
|
type: string
|
|
keymasters:
|
|
description: Persons who carry a key and are able to open the space upon request. One of the fields must be specified.
|
|
required: false
|
|
type: list
|
|
keys:
|
|
name:
|
|
description: Real Name of the keymaster.
|
|
required: false
|
|
type: string
|
|
irc_nick:
|
|
description: Contact the person with this nickname directly in irc if available. The irc channel to be used is defined in the contact/irc field.
|
|
required: false
|
|
type: string
|
|
phone:
|
|
description: Phone number of the keymaster.
|
|
required: false
|
|
type: string
|
|
email:
|
|
description: Email address of the keymaster.
|
|
required: false
|
|
type: string
|
|
twitter:
|
|
description: X username of the keymaster.
|
|
required: false
|
|
type: string
|
|
irc:
|
|
description: The IRC channel of the Hackerspace
|
|
required: false
|
|
type: string
|
|
twitter:
|
|
description: The X account of the Hackerspace.
|
|
required: false
|
|
type: string
|
|
facebook:
|
|
description: The facebook URL of the Hackerspace.
|
|
required: false
|
|
type: string
|
|
identica:
|
|
description: The Identi.ca or StatusNet account of the Hackerspace.
|
|
required: false
|
|
type: string
|
|
foursquare:
|
|
description: The Foursquare ID of the Hackerspace.
|
|
required: false
|
|
type: string
|
|
email:
|
|
description: The email address of the Hackerspace.
|
|
required: true
|
|
type: string
|
|
ml:
|
|
description: The mailing list of the Hackerspace.
|
|
required: false
|
|
type: string
|
|
jabber:
|
|
description: The public Jabber/XMPP multi-user chatroom of the Hackerspace.
|
|
required: false
|
|
type: string
|
|
issue_mail:
|
|
description: A separate email address for issue reports.
|
|
required: false
|
|
type: string
|
|
issue_report_channels:
|
|
description: "The reporting channel for issues. Valid values are `email`, `issue_mail`, `twitter` or `ml`"
|
|
required: true
|
|
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."
|
|
required: true
|
|
type: string
|
|
icon_open:
|
|
description: The URL which is publicly accessible of the icon for the open Hackerspace.
|
|
required: false
|
|
type: string
|
|
icon_closed:
|
|
description: The URL which is publicly accessible of the icon for the closed Hackerspace.
|
|
required: false
|
|
type: string
|
|
feeds:
|
|
description: Feeds where users can get updates of your space.
|
|
required: false
|
|
type: map
|
|
keys:
|
|
blog:
|
|
description: The blog of your Hackerspace.
|
|
required: false
|
|
type: map
|
|
keys:
|
|
type:
|
|
description: Type of the feed, for example rss, atom, ical
|
|
required: false
|
|
type: string
|
|
url:
|
|
description: Feed URL
|
|
required: true
|
|
type: string
|
|
wiki:
|
|
description: The wiki of your Hackerspace.
|
|
required: false
|
|
type: map
|
|
keys:
|
|
type:
|
|
description: Type of the feed, for example rss, atom, ical
|
|
required: false
|
|
type: string
|
|
url:
|
|
description: Feed URL
|
|
required: true
|
|
type: string
|
|
calendar:
|
|
description: The calendar of your Hackerspace.
|
|
required: false
|
|
type: map
|
|
keys:
|
|
type:
|
|
description: Type of the feed, for example rss, atom, ical
|
|
required: false
|
|
type: string
|
|
url:
|
|
description: Feed URL
|
|
required: true
|
|
type: string
|
|
flicker:
|
|
description: The Flicker stream of your Hackerspace.
|
|
required: false
|
|
type: map
|
|
keys:
|
|
type:
|
|
description: Type of the feed, for example rss, atom, ical
|
|
required: false
|
|
type: string
|
|
url:
|
|
description: Feed URL
|
|
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.
|
|
required: false
|
|
type: map
|
|
keys:
|
|
schedule:
|
|
description: Cache update cycle. Valid values are m.02 | m.05 | m.10 | m.15 | m.30 | h.01 | h.02 | h.04 | h.08 | h.12 | d.01 |
|
|
required: true
|
|
type: string
|
|
projects:
|
|
description: Your project sites (links to GitHub, wikis or wherever your projects are hosted).
|
|
required: false
|
|
type: list
|
|
radio_show:
|
|
description: A list of radio shows that your hackerspace might broadcast.
|
|
required: false
|
|
type: list
|
|
keys:
|
|
name:
|
|
description: The name of the radio show.
|
|
required: true
|
|
type: string
|
|
url:
|
|
description: The stream URL of the radio show.
|
|
required: true
|
|
type: string
|
|
type:
|
|
description: The stream encoder. Valid values are mp3 or ogg
|
|
required: true
|
|
type: string
|
|
start:
|
|
description: Specify the start time by using the ISO 8601 standard.
|
|
required: true
|
|
type: string
|
|
end:
|
|
description: Specify the end time by using the ISO 8601 standard.
|
|
required: true
|
|
type: string
|
|
sensors:
|
|
description: List of sensors to expose.
|
|
required: false
|
|
type: list
|
|
keys:
|
|
temperature:
|
|
description: List of temperature sensors.
|
|
required: true
|
|
type: string
|
|
humidity:
|
|
description: List of humidity sensors.
|
|
required: true
|
|
type: string
|
|
{% endconfiguration %}
|
|
|
|
The list of sensors can be any sensor, not just 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](https://www.eastermundigen.ch/), a Hackerspace in Switzerland, could look like this.
|
|
|
|
```yaml
|
|
# 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"
|
|
```
|