"""Support for a Hue API to control Home Assistant.""" import logging import hashlib from aiohttp import web from homeassistant import core from homeassistant.components import ( climate, cover, fan, light, media_player, scene, script, ) from homeassistant.components.climate.const import ( SERVICE_SET_TEMPERATURE, SUPPORT_TARGET_TEMPERATURE, ) from homeassistant.components.cover import ( ATTR_CURRENT_POSITION, ATTR_POSITION, SERVICE_SET_COVER_POSITION, SUPPORT_SET_POSITION, ) from homeassistant.components.fan import ( ATTR_SPEED, SPEED_HIGH, SPEED_LOW, SPEED_MEDIUM, SPEED_OFF, SUPPORT_SET_SPEED, ) from homeassistant.components.http import HomeAssistantView from homeassistant.components.http.const import KEY_REAL_IP from homeassistant.components.light import ( ATTR_BRIGHTNESS, ATTR_HS_COLOR, ATTR_COLOR_TEMP, SUPPORT_BRIGHTNESS, SUPPORT_COLOR, SUPPORT_COLOR_TEMP, ) from homeassistant.components.media_player.const import ( ATTR_MEDIA_VOLUME_LEVEL, SUPPORT_VOLUME_SET, ) from homeassistant.const import ( ATTR_ENTITY_ID, ATTR_SUPPORTED_FEATURES, ATTR_TEMPERATURE, HTTP_BAD_REQUEST, HTTP_NOT_FOUND, SERVICE_CLOSE_COVER, SERVICE_OPEN_COVER, SERVICE_TURN_OFF, SERVICE_TURN_ON, SERVICE_VOLUME_SET, STATE_OFF, STATE_ON, ) from homeassistant.util.network import is_local _LOGGER = logging.getLogger(__name__) HUE_API_STATE_ON = "on" HUE_API_STATE_BRI = "bri" HUE_API_STATE_HUE = "hue" HUE_API_STATE_SAT = "sat" HUE_API_STATE_COLORMODE = "colormode" HUE_API_STATE_CT = "ct" HUE_API_STATE_EFFECT = "effect" HUE_API_STATE_HUE_MAX = 65535.0 HUE_API_STATE_SAT_MAX = 254.0 HUE_API_STATE_BRI_MAX = 255.0 STATE_BRIGHTNESS = HUE_API_STATE_BRI STATE_HUE = HUE_API_STATE_HUE STATE_SATURATION = HUE_API_STATE_SAT STATE_COLOR_TEMP = HUE_API_STATE_CT class HueUsernameView(HomeAssistantView): """Handle requests to create a username for the emulated hue bridge.""" url = "/api" name = "emulated_hue:api:create_username" extra_urls = ["/api/"] requires_auth = False async def post(self, request): """Handle a POST request.""" try: data = await request.json() except ValueError: return self.json_message("Invalid JSON", HTTP_BAD_REQUEST) if "devicetype" not in data: return self.json_message("devicetype not specified", HTTP_BAD_REQUEST) if not is_local(request[KEY_REAL_IP]): return self.json_message("only local IPs allowed", HTTP_BAD_REQUEST) return self.json([{"success": {"username": "12345678901234567890"}}]) class HueAllGroupsStateView(HomeAssistantView): """Group handler.""" url = "/api/{username}/groups" name = "emulated_hue:all_groups:state" requires_auth = False def __init__(self, config): """Initialize the instance of the view.""" self.config = config @core.callback def get(self, request, username): """Process a request to make the Brilliant Lightpad work.""" if not is_local(request[KEY_REAL_IP]): return self.json_message("only local IPs allowed", HTTP_BAD_REQUEST) return self.json({}) class HueGroupView(HomeAssistantView): """Group handler to get Logitech Pop working.""" url = "/api/{username}/groups/0/action" name = "emulated_hue:groups:state" requires_auth = False def __init__(self, config): """Initialize the instance of the view.""" self.config = config @core.callback def put(self, request, username): """Process a request to make the Logitech Pop working.""" if not is_local(request[KEY_REAL_IP]): return self.json_message("only local IPs allowed", HTTP_BAD_REQUEST) return self.json( [ { "error": { "address": "/groups/0/action/scene", "type": 7, "description": "invalid value, dummy for parameter, scene", } } ] ) class HueAllLightsStateView(HomeAssistantView): """Handle requests for getting and setting info about entities.""" url = "/api/{username}/lights" name = "emulated_hue:lights:state" requires_auth = False def __init__(self, config): """Initialize the instance of the view.""" self.config = config @core.callback def get(self, request, username): """Process a request to get the list of available lights.""" if not is_local(request[KEY_REAL_IP]): return self.json_message("only local IPs allowed", HTTP_BAD_REQUEST) hass = request.app["hass"] json_response = {} for entity in hass.states.async_all(): if self.config.is_entity_exposed(entity): state = get_entity_state(self.config, entity) number = self.config.entity_id_to_number(entity.entity_id) json_response[number] = entity_to_json(self.config, entity, state) return self.json(json_response) class HueOneLightStateView(HomeAssistantView): """Handle requests for getting and setting info about entities.""" url = "/api/{username}/lights/{entity_id}" name = "emulated_hue:light:state" requires_auth = False def __init__(self, config): """Initialize the instance of the view.""" self.config = config @core.callback def get(self, request, username, entity_id): """Process a request to get the state of an individual light.""" if not is_local(request[KEY_REAL_IP]): return self.json_message("only local IPs allowed", HTTP_BAD_REQUEST) hass = request.app["hass"] hass_entity_id = self.config.number_to_entity_id(entity_id) if hass_entity_id is None: _LOGGER.error( "Unknown entity number: %s not found in emulated_hue_ids.json", entity_id, ) return web.Response(text="Entity not found", status=404) entity = hass.states.get(hass_entity_id) if entity is None: _LOGGER.error("Entity not found: %s", hass_entity_id) return web.Response(text="Entity not found", status=404) if not self.config.is_entity_exposed(entity): _LOGGER.error("Entity not exposed: %s", entity_id) return web.Response(text="Entity not exposed", status=404) state = get_entity_state(self.config, entity) json_response = entity_to_json(self.config, entity, state) return self.json(json_response) class HueOneLightChangeView(HomeAssistantView): """Handle requests for getting and setting info about entities.""" url = "/api/{username}/lights/{entity_number}/state" name = "emulated_hue:light:state" requires_auth = False def __init__(self, config): """Initialize the instance of the view.""" self.config = config async def put(self, request, username, entity_number): """Process a request to set the state of an individual light.""" if not is_local(request[KEY_REAL_IP]): return self.json_message("only local IPs allowed", HTTP_BAD_REQUEST) config = self.config hass = request.app["hass"] entity_id = config.number_to_entity_id(entity_number) if entity_id is None: _LOGGER.error("Unknown entity number: %s", entity_number) return self.json_message("Entity not found", HTTP_NOT_FOUND) entity = hass.states.get(entity_id) if entity is None: _LOGGER.error("Entity not found: %s", entity_id) return self.json_message("Entity not found", HTTP_NOT_FOUND) if not config.is_entity_exposed(entity): _LOGGER.error("Entity not exposed: %s", entity_id) return web.Response(text="Entity not exposed", status=404) try: request_json = await request.json() except ValueError: _LOGGER.error("Received invalid json") return self.json_message("Invalid JSON", HTTP_BAD_REQUEST) # Parse the request into requested "on" status and brightness parsed = parse_hue_api_put_light_body(request_json, entity) if parsed is None: _LOGGER.error("Unable to parse data: %s", request_json) return web.Response(text="Bad request", status=400) # Choose general HA domain domain = core.DOMAIN # Entity needs separate call to turn on turn_on_needed = False # Convert the resulting "on" status into the service we need to call service = SERVICE_TURN_ON if parsed[STATE_ON] else SERVICE_TURN_OFF # Construct what we need to send to the service data = {ATTR_ENTITY_ID: entity_id} # Make sure the entity actually supports brightness entity_features = entity.attributes.get(ATTR_SUPPORTED_FEATURES, 0) if entity.domain == light.DOMAIN: if parsed[STATE_ON]: if entity_features & SUPPORT_BRIGHTNESS: if parsed[STATE_BRIGHTNESS] is not None: data[ATTR_BRIGHTNESS] = parsed[STATE_BRIGHTNESS] if entity_features & SUPPORT_COLOR: if parsed[STATE_HUE] is not None: if parsed[STATE_SATURATION]: sat = parsed[STATE_SATURATION] else: sat = 0 hue = parsed[STATE_HUE] # Convert hs values to hass hs values sat = int((sat / HUE_API_STATE_SAT_MAX) * 100) hue = int((hue / HUE_API_STATE_HUE_MAX) * 360) data[ATTR_HS_COLOR] = (hue, sat) # If the requested entity is a script add some variables elif entity.domain == script.DOMAIN: data["variables"] = { "requested_state": STATE_ON if parsed[STATE_ON] else STATE_OFF } if parsed[STATE_BRIGHTNESS] is not None: data["variables"]["requested_level"] = parsed[STATE_BRIGHTNESS] # If the requested entity is a climate, set the temperature elif entity.domain == climate.DOMAIN: # We don't support turning climate devices on or off, # only setting the temperature service = None if entity_features & SUPPORT_TARGET_TEMPERATURE: if parsed[STATE_BRIGHTNESS] is not None: domain = entity.domain service = SERVICE_SET_TEMPERATURE data[ATTR_TEMPERATURE] = parsed[STATE_BRIGHTNESS] # If the requested entity is a media player, convert to volume elif entity.domain == media_player.DOMAIN: if entity_features & SUPPORT_VOLUME_SET: if parsed[STATE_BRIGHTNESS] is not None: turn_on_needed = True domain = entity.domain service = SERVICE_VOLUME_SET # Convert 0-100 to 0.0-1.0 data[ATTR_MEDIA_VOLUME_LEVEL] = parsed[STATE_BRIGHTNESS] / 100.0 # If the requested entity is a cover, convert to open_cover/close_cover elif entity.domain == cover.DOMAIN: domain = entity.domain if service == SERVICE_TURN_ON: service = SERVICE_OPEN_COVER else: service = SERVICE_CLOSE_COVER if entity_features & SUPPORT_SET_POSITION: if parsed[STATE_BRIGHTNESS] is not None: domain = entity.domain service = SERVICE_SET_COVER_POSITION data[ATTR_POSITION] = parsed[STATE_BRIGHTNESS] # If the requested entity is a fan, convert to speed elif entity.domain == fan.DOMAIN: if entity_features & SUPPORT_SET_SPEED: if parsed[STATE_BRIGHTNESS] is not None: domain = entity.domain # Convert 0-100 to a fan speed brightness = parsed[STATE_BRIGHTNESS] if brightness == 0: data[ATTR_SPEED] = SPEED_OFF elif 0 < brightness <= 33.3: data[ATTR_SPEED] = SPEED_LOW elif 33.3 < brightness <= 66.6: data[ATTR_SPEED] = SPEED_MEDIUM elif 66.6 < brightness <= 100: data[ATTR_SPEED] = SPEED_HIGH if entity.domain in config.off_maps_to_on_domains: # Map the off command to on service = SERVICE_TURN_ON # Caching is required because things like scripts and scenes won't # report as "off" to Alexa if an "off" command is received, because # they'll map to "on". Thus, instead of reporting its actual # status, we report what Alexa will want to see, which is the same # as the actual requested command. config.cached_states[entity_id] = parsed # Separate call to turn on needed if turn_on_needed: hass.async_create_task( hass.services.async_call( core.DOMAIN, SERVICE_TURN_ON, {ATTR_ENTITY_ID: entity_id}, blocking=True, ) ) if service is not None: hass.async_create_task( hass.services.async_call(domain, service, data, blocking=True) ) json_response = [ create_hue_success_response(entity_id, HUE_API_STATE_ON, parsed[STATE_ON]) ] if parsed[STATE_BRIGHTNESS] is not None: json_response.append( create_hue_success_response( entity_id, HUE_API_STATE_BRI, parsed[STATE_BRIGHTNESS] ) ) if parsed[STATE_HUE] is not None: json_response.append( create_hue_success_response( entity_id, HUE_API_STATE_HUE, parsed[STATE_HUE] ) ) if parsed[STATE_SATURATION] is not None: json_response.append( create_hue_success_response( entity_id, HUE_API_STATE_SAT, parsed[STATE_SATURATION] ) ) return self.json(json_response) def parse_hue_api_put_light_body(request_json, entity): """Parse the body of a request to change the state of a light.""" data = { STATE_BRIGHTNESS: None, STATE_HUE: None, STATE_ON: False, STATE_SATURATION: None, STATE_COLOR_TEMP: None, } # Make sure the entity actually supports brightness entity_features = entity.attributes.get(ATTR_SUPPORTED_FEATURES, 0) if HUE_API_STATE_ON in request_json: if not isinstance(request_json[HUE_API_STATE_ON], bool): return None if request_json[HUE_API_STATE_ON]: # Echo requested device be turned on data[STATE_BRIGHTNESS] = None data[STATE_ON] = True else: # Echo requested device be turned off data[STATE_BRIGHTNESS] = None data[STATE_ON] = False if HUE_API_STATE_HUE in request_json: try: # Clamp brightness from 0 to 65535 data[STATE_HUE] = max( 0, min(int(request_json[HUE_API_STATE_HUE]), HUE_API_STATE_HUE_MAX) ) except ValueError: return None if HUE_API_STATE_SAT in request_json: try: # Clamp saturation from 0 to 254 data[STATE_SATURATION] = max( 0, min(int(request_json[HUE_API_STATE_SAT]), HUE_API_STATE_SAT_MAX) ) except ValueError: return None if HUE_API_STATE_BRI in request_json: try: # Clamp brightness from 0 to 255 data[STATE_BRIGHTNESS] = max( 0, min(int(request_json[HUE_API_STATE_BRI]), HUE_API_STATE_BRI_MAX) ) except ValueError: return None if entity.domain == light.DOMAIN: data[STATE_ON] = data[STATE_BRIGHTNESS] > 0 if not entity_features & SUPPORT_BRIGHTNESS: data[STATE_BRIGHTNESS] = None elif entity.domain == scene.DOMAIN: data[STATE_BRIGHTNESS] = None data[STATE_ON] = True elif entity.domain in [ script.DOMAIN, media_player.DOMAIN, fan.DOMAIN, cover.DOMAIN, climate.DOMAIN, ]: # Convert 0-255 to 0-100 level = (data[STATE_BRIGHTNESS] / HUE_API_STATE_BRI_MAX) * 100 data[STATE_BRIGHTNESS] = round(level) data[STATE_ON] = True if HUE_API_STATE_CT in request_json: data[STATE_COLOR_TEMP] = request_json[HUE_API_STATE_CT] return data def get_entity_state(config, entity): """Retrieve and convert state and brightness values for an entity.""" cached_state = config.cached_states.get(entity.entity_id, None) data = { STATE_BRIGHTNESS: None, STATE_HUE: None, STATE_ON: False, STATE_SATURATION: None, STATE_COLOR_TEMP: None, } if cached_state is None: data[STATE_ON] = entity.state != STATE_OFF if data[STATE_ON]: data[STATE_BRIGHTNESS] = entity.attributes.get(ATTR_BRIGHTNESS, 0) hue_sat = entity.attributes.get(ATTR_HS_COLOR, None) if hue_sat is not None: hue = hue_sat[0] sat = hue_sat[1] # convert hass hs values back to hue hs values data[STATE_HUE] = int((hue / 360.0) * HUE_API_STATE_HUE_MAX) data[STATE_SATURATION] = int((sat / 100.0) * HUE_API_STATE_SAT_MAX) data[STATE_COLOR_TEMP] = entity.attributes.get(ATTR_COLOR_TEMP, 0) else: data[STATE_BRIGHTNESS] = 0 data[STATE_HUE] = 0 data[STATE_SATURATION] = 0 data[STATE_COLOR_TEMP] = 0 # Make sure the entity actually supports brightness entity_features = entity.attributes.get(ATTR_SUPPORTED_FEATURES, 0) if entity.domain == light.DOMAIN: if entity_features & SUPPORT_BRIGHTNESS: pass elif entity.domain == climate.DOMAIN: temperature = entity.attributes.get(ATTR_TEMPERATURE, 0) # Convert 0-100 to 0-255 data[STATE_BRIGHTNESS] = round(temperature * 255 / 100) elif entity.domain == media_player.DOMAIN: level = entity.attributes.get( ATTR_MEDIA_VOLUME_LEVEL, 1.0 if data[STATE_ON] else 0.0 ) # Convert 0.0-1.0 to 0-255 data[STATE_BRIGHTNESS] = round(min(1.0, level) * HUE_API_STATE_BRI_MAX) elif entity.domain == fan.DOMAIN: speed = entity.attributes.get(ATTR_SPEED, 0) # Convert 0.0-1.0 to 0-255 data[STATE_BRIGHTNESS] = 0 if speed == SPEED_LOW: data[STATE_BRIGHTNESS] = 85 elif speed == SPEED_MEDIUM: data[STATE_BRIGHTNESS] = 170 elif speed == SPEED_HIGH: data[STATE_BRIGHTNESS] = 255 elif entity.domain == cover.DOMAIN: level = entity.attributes.get(ATTR_CURRENT_POSITION, 0) data[STATE_BRIGHTNESS] = round(level / 100 * HUE_API_STATE_BRI_MAX) else: data = cached_state # Make sure brightness is valid if data[STATE_BRIGHTNESS] is None: data[STATE_BRIGHTNESS] = 255 if data[STATE_ON] else 0 # Make sure hue/saturation are valid if (data[STATE_HUE] is None) or (data[STATE_SATURATION] is None): data[STATE_HUE] = 0 data[STATE_SATURATION] = 0 # If the light is off, set the color to off if data[STATE_BRIGHTNESS] == 0: data[STATE_HUE] = 0 data[STATE_SATURATION] = 0 return data def entity_to_json(config, entity, state): """Convert an entity to its Hue bridge JSON representation.""" entity_features = entity.attributes.get(ATTR_SUPPORTED_FEATURES, 0) unique_id = hashlib.md5(entity.entity_id.encode()).hexdigest()[:18] unique_id = "%s:%s:%s:%s:%s:%s:%s:%s-%s" % ( unique_id[0:2], unique_id[2:4], unique_id[4:6], unique_id[6:8], unique_id[8:10], unique_id[10:12], unique_id[12:14], unique_id[14:16], unique_id[16:18], ) retval = { "state": { HUE_API_STATE_ON: state[STATE_ON], "reachable": True, "mode": "homeautomation", }, "name": config.get_entity_name(entity), "uniqueid": unique_id, "manufacturername": "Home Assistant", "swversion": "123", } if (entity_features & SUPPORT_BRIGHTNESS) and ( entity_features & SUPPORT_COLOR_TEMP ): retval["type"] = "Extended color light" retval["modelid"] = "HAS231" retval["state"].update( { HUE_API_STATE_BRI: state[STATE_BRIGHTNESS], HUE_API_STATE_COLORMODE: "ct", HUE_API_STATE_EFFECT: "none", HUE_API_STATE_CT: state[STATE_COLOR_TEMP], } ) elif (entity_features & SUPPORT_BRIGHTNESS) and (entity_features & SUPPORT_COLOR): retval["type"] = "Color light" retval["modelid"] = "HASS213" retval["state"].update( { HUE_API_STATE_BRI: state[STATE_BRIGHTNESS], HUE_API_STATE_COLORMODE: "hs", HUE_API_STATE_EFFECT: "none", HUE_API_STATE_HUE: state[STATE_HUE], HUE_API_STATE_SAT: state[STATE_SATURATION], } ) elif entity_features & SUPPORT_COLOR_TEMP: retval["type"] = "Color temperature light" retval["modelid"] = "HASS312" retval["state"].update( {HUE_API_STATE_COLORMODE: "ct", HUE_API_STATE_CT: state[STATE_COLOR_TEMP]} ) elif ( entity_features & ( SUPPORT_BRIGHTNESS | SUPPORT_SET_POSITION | SUPPORT_SET_SPEED | SUPPORT_VOLUME_SET | SUPPORT_TARGET_TEMPERATURE ) ) or entity.domain == script.DOMAIN: retval["type"] = "Dimmable light" retval["modelid"] = "HASS123" retval["state"].update({HUE_API_STATE_BRI: state[STATE_BRIGHTNESS]}) else: retval["type"] = "On/off light" retval["modelid"] = "HASS321" return retval def create_hue_success_response(entity_id, attr, value): """Create a success response for an attribute set on a light.""" success_key = f"/lights/{entity_id}/state/{attr}" return {"success": {success_key: value}}