Merge pull request #118 from home-assistant/dev

Release 0.49

Author: pvizeli

API.md

@@ -1,29 +1,30 @@
-# HassIO Server
+# Hass.io Server
 
-## HassIO REST API
+## Hass.io RESTful API
 
-Interface for HomeAssistant to control things from supervisor.
+Interface for Home Assistant to control things from supervisor.
 
 On error:
+
 ```json
 {
     "result": "error",
     "message": ""
 }
 ```
 
-On success
+On success:
+
 ```json
 {
     "result": "ok",
     "data": { }
 }
 ```
 
-### HassIO
+### Hass.io
 
 - GET `/supervisor/ping`
-
 - GET `/supervisor/info`
 
 The addons from `addons` are only installed one.
@@ -54,14 +55,17 @@ The addons from `addons` are only installed one.
 ```
 
 - POST `/supervisor/update`
+
 Optional:
+
 ```json
 {
     "version": "VERSION"
 }
 ```
 
 - POST `/supervisor/options`
+
 ```json
 {
     "beta_channel": "true|false",
@@ -78,11 +82,12 @@ Reload addons/version.
 
 - GET `/supervisor/logs`
 
-Output the raw docker log
+Output is the raw docker log.
 
 ### Security
 
 - GET `/security/info`
+
 ```json
 {
     "initialize": "bool",
@@ -91,13 +96,15 @@ Output the raw docker log
 ```
 
 - POST `/security/options`
+
 ```json
 {
     "password": "xy"
 }
 ```
 
 - POST `/security/totp`
+
 ```json
 {
     "password": "xy"
@@ -117,6 +124,7 @@ Return QR-Code
 ### Backup/Snapshot
 
 - GET `/snapshots`
+
 ```json
 {
     "snapshots": [
@@ -132,13 +140,15 @@ Return QR-Code
 - POST `/snapshots/reload`
 
 - POST `/snapshots/new/full`
+
 ```json
 {
     "name": "Optional"
 }
 ```
 
 - POST `/snapshots/new/partial`
+
 ```json
 {
     "name": "Optional",
@@ -150,6 +160,7 @@ Return QR-Code
 - POST `/snapshots/reload`
 
 - GET `/snapshots/{slug}/info`
+
 ```json
 {
     "slug": "SNAPSHOT ID",
@@ -174,10 +185,9 @@ Return QR-Code
 ```
 
 - POST `/snapshots/{slug}/remove`
-
 - POST `/snapshots/{slug}/restore/full`
-
 - POST `/snapshots/{slug}/restore/partial`
+
 ```json
 {
     "homeassistant": "bool",
@@ -187,14 +197,14 @@ Return QR-Code
 ```
 
 ### Host
-- POST `/host/reload`
 
+- POST `/host/reload`
 - POST `/host/shutdown`
-
 - POST `/host/reboot`
-
 - GET `/host/info`
+
 See HostControl info command.
+
 ```json
 {
     "type": "",
@@ -207,23 +217,45 @@ See HostControl info command.
 ```
 
 - POST `/host/update`
+
 Optional:
+
 ```json
 {
     "version": "VERSION"
 }
 ```
 
+- GET `/host/hardware`
+```json
+{
+    "serial": ["/dev/xy"],
+    "input": ["Input device name"],
+    "disk": ["/dev/sdax"],
+    "audio": {
+        "CARD_ID": {
+            "name": "xy",
+            "type": "microphone",
+            "devices": {
+                "DEV_ID": "type of device"
+            }
+        }
+    }
+}
+```
+
 ### Network
 
 - GET `/network/info`
+
 ```json
 {
     "hostname": ""
 }
 ```
 
 - POST `/network/options`
+
 ```json
 {
     "hostname": "",
@@ -235,7 +267,7 @@ Optional:
 }
 ```
 
-### HomeAssistant
+### Home Assistant
 
 - GET `/homeassistant/info`
 
@@ -250,7 +282,9 @@ Optional:
 ```
 
 - POST `/homeassistant/update`
+
 Optional:
+
 ```json
 {
     "version": "VERSION"
@@ -259,11 +293,11 @@ Optional:
 
 - GET `/homeassistant/logs`
 
-Output the raw docker log
+Output is the raw Docker log.
 
 - POST `/homeassistant/restart`
-
 - POST `/homeassistant/options`
+
 ```json
 {
     "devices": [],
@@ -274,11 +308,11 @@ Output the raw docker log
 
 Image with `null` and last_version with `null` reset this options.
 
-### REST API addons
+### RESTful for API addons
 
 - GET `/addons`
 
-Get all available addons
+Get all available addons.
 
 ```json
 {
@@ -312,8 +346,8 @@ Get all available addons
 ```
 
 - POST `/addons/reload`
-
 - GET `/addons/{addon}/info`
+
 ```json
 {
     "name": "xy bla",
@@ -340,6 +374,7 @@ Get all available addons
 - GET `/addons/{addon}/logo`
 
 - POST `/addons/{addon}/options`
+
 ```json
 {
     "boot": "auto|manual",
@@ -358,7 +393,9 @@ For reset custom network settings, set it `null`.
 - POST `/addons/{addon}/stop`
 
 - POST `/addons/{addon}/install`
+
 Optional:
+
 ```json
 {
     "version": "VERSION"
@@ -368,7 +405,9 @@ Optional:
 - POST `/addons/{addon}/uninstall`
 
 - POST `/addons/{addon}/update`
+
 Optional:
+
 ```json
 {
     "version": "VERSION"
@@ -377,15 +416,16 @@ Optional:
 
 - GET `/addons/{addon}/logs`
 
-Output the raw docker log
+Output is the raw Docker log.
 
 - POST `/addons/{addon}/restart`
 
 ## Host Control
 
-Communicate over unix socket with a host daemon.
+Communicate over UNIX socket with a host daemon.
 
 - commands
+
 ```
 # info
 -> {'type', 'version', 'last_version', 'features', 'hostname'}
@@ -404,7 +444,8 @@ Communicate over unix socket with a host daemon.
 # network int route xy
 ```
 
-features:
+Features:
+
 - shutdown
 - reboot
 - update

hassio/api/__init__.py

@@ -28,11 +28,12 @@ def __init__(self, config, loop):
         self._handler = None
         self.server = None
 
-    def register_host(self, host_control):
+    def register_host(self, host_control, hardware):
         """Register hostcontrol function."""
-        api_host = APIHost(self.config, self.loop, host_control)
+        api_host = APIHost(self.config, self.loop, host_control, hardware)
 
         self.webapp.router.add_get('/host/info', api_host.info)
+        self.webapp.router.add_get('/host/hardware', api_host.hardware)
         self.webapp.router.add_post('/host/reboot', api_host.reboot)
         self.webapp.router.add_post('/host/shutdown', api_host.shutdown)
         self.webapp.router.add_post('/host/update', api_host.update)

hassio/api/host.py

@@ -7,7 +7,7 @@
 from .util import api_process_hostcontrol, api_process, api_validate
 from ..const import (
     ATTR_VERSION, ATTR_LAST_VERSION, ATTR_TYPE, ATTR_HOSTNAME, ATTR_FEATURES,
-    ATTR_OS)
+    ATTR_OS, ATTR_SERIAL, ATTR_INPUT, ATTR_DISK, ATTR_AUDIO)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -19,11 +19,12 @@
 class APIHost(object):
     """Handle rest api for host functions."""
 
-    def __init__(self, config, loop, host_control):
+    def __init__(self, config, loop, host_control, hardware):
         """Initialize host rest api part."""
         self.config = config
         self.loop = loop
         self.host_control = host_control
+        self.local_hw = hardware
 
     @api_process
     async def info(self, request):
@@ -58,3 +59,13 @@ async def update(self, request):
 
         return await asyncio.shield(
             self.host_control.update(version=version), loop=self.loop)
+
+    @api_process
+    async def hardware(self, request):
+        """Return local hardware infos."""
+        return {
+            ATTR_SERIAL: self.local_hw.serial_devices,
+            ATTR_INPUT: self.local_hw.input_devices,
+            ATTR_DISK: self.local_hw.disk_devices,
+            ATTR_AUDIO: self.local_hw.audio_devices,
+        }

hassio/const.py

@@ -1,7 +1,7 @@
 """Const file for HassIO."""
 from pathlib import Path
 
-HASSIO_VERSION = '0.48'
+HASSIO_VERSION = '0.49'
 
 URL_HASSIO_VERSION = ('https://raw.githubusercontent.com/home-assistant/'
                       'hassio/master/version.json')
@@ -101,6 +101,10 @@
 ATTR_TIMEOUT = 'timeout'
 ATTR_AUTO_UPDATE = 'auto_update'
 ATTR_CUSTOM = 'custom'
+ATTR_AUDIO = 'audio'
+ATTR_INPUT = 'input'
+ATTR_DISK = 'disk'
+ATTR_SERIAL = 'serial'
 
 STARTUP_INITIALIZE = 'initialize'
 STARTUP_SYSTEM = 'system'