jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-27 11:16:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix spaceapi (#10296)

Browse Source 
* fixed error in configuration description

* location / address is not required by spec

* add all fields to documentation
This commit is contained in:
bouni 2019-09-22 01:23:27 +02:00 committed by Fabian Affolter
parent 15c4bc2d63
commit 23c1629827
1 changed files with 162 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

176
source/_components/spaceapi.markdown
View File

@ -38,13 +38,13 @@ logo:
description: URL which is publicly accessible of the logo. description: URL which is publicly accessible of the logo.
required: true required: true
type: string type: string
logo: url:
description: URL of the hackerspace's web site. description: URL of the hackerspace's web site.
required: true required: true
type: string type: string
location: location:
description: Location of the Hackerspace. description: Location of the Hackerspace.
required: true required: false
type: map type: map
keys: keys:
address: address:
@ -52,28 +52,81 @@ location:
required: true required: true
type: string type: string
contact: contact:
description: Contact information of the Hackerspace. description: Contact information of the Hackerspace. At least one entry is mandatory.
required: true required: true
type: map type: map
keys: keys:
email: phone:
description: The email address of the Hackerspace. description: The phone number of the Hackerspace.
required: true
type: string
irc:
description: The IRC channel of the Hackerspace
required: false required: false
type: string type: string
mailing_list: sip:
description: The mailing list of the Hackerspace. 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: Twitter username of the keymaster.
required: false
type: string
irc:
description: The IRC channel of the Hackerspace
required: false required: false
type: string type: string
twitter: twitter:
description: The Twitter account of the Hackerspace. description: The Twitter account of the Hackerspace.
required: false required: false
type: string 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: issue_report_channels:
description: "The reporting channel for issues. Pick an entity from `contact:`." description: "The reporting channel for issues. Valid values are email, issue_mail, twitter or ml"
required: true required: true
type: list type: list
state: state:
@ -93,6 +146,101 @@ state:
description: The URL which is publicly accessible of the icon for the closed Hackerspace. description: The URL which is publicly accessible of the icon for the closed Hackerspace.
required: false required: false
type: string 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: sensors:
description: List of sensors to expose. description: List of sensors to expose.
required: false required: false
@ -112,8 +260,8 @@ The list of sensors can be any sensor, not just temperature or humidity.
## Sensor specific location ## Sensor specific location
The [SpaceAPI specification](https://spaceapi.io/pages/docs.html) requires every sensor to provide a location. The [SpaceAPI specification](https://spaceapi.io/pages/docs.html) requires every sensor to provide a location.
In order to set a sensor specific location do the following steps: In order to set a sensor specific location do the following steps:
1. Go to Configuration -> Customization 1. Go to Configuration -> Customization
2. Select the sensor entity 2. Select the sensor entity