Skip to content

Commit

Permalink
feat(feature_support): add a default supported_feature value
Browse files Browse the repository at this point in the history 
related #314
  • Loading branch information
@xaviml
xaviml committed Jun 6, 2021
1 parent 3fb56d2 commit c4328a9
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 2 deletions.
3 changes: 2 additions & 1 deletion apps/controllerx/cx_core/feature_support/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ def __init__(
self,
entity_id: str,
controller: "TypeController",
supported_features: Optional[int] = None,
update_supported_features=False,
) -> None:
self.entity_id = entity_id
self.controller = controller
self._supported_features = None
self._supported_features = supported_features
self.update_supported_features = update_supported_features

@property
Expand Down
1 change: 1 addition & 0 deletions apps/controllerx/cx_core/feature_support/media_player.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ class MediaPlayerSupport:
SELECT_SOUND_MODE = 65536
SUPPORT_BROWSE_MEDIA = 131072
SUPPORT_REPEAT_SET = 262144
SUPPORT_GROUPING = 524288
3 changes: 2 additions & 1 deletion apps/controllerx/cx_core/type_controller.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ async def init(self) -> None:
self.entity = self.get_entity(self.args[self.entity_arg]) # type: ignore
await self.check_domain(self.entity.name)
update_supported_features = self.args.get("update_supported_features", False)
supported_features = self.args.get("supported_features")
self.feature_support = FeatureSupport(
self.entity.name, self, update_supported_features
self.entity.name, self, supported_features, update_supported_features
)
await super().init()

Expand Down
62 changes: 62 additions & 0 deletions docs/start/type-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ This controller allows the devices to control light or group of lights. This all
| `add_transition` | boolean | True | If `true` adds transition if supported, otherwise it does not adds the `transition` attribute. |
| `add_transition_turn_toggle` | boolean | True | If `false` does not add transition when turning on/off or toggling, otherwise it adds the `transition` attribute to the call. See [FAQ #6](/controllerx/faq#6-light-is-not-turning-on-to-the-previous-brightness) for a further explanation on the use of this parameter. |
| `color_wheel` | string \| list | `default_color_wheel` | It defines the color wheel used when changing the xy color either when click or hold actions are used. Check down to know more about the options. |
| `supported_features` | int | `0b10111111` or `191` | See [below](#supported_features-field) for the explanation. |
| `update_supported_features` | boolean | False | If `true`, it will check the supported features field everytime before calling any call service action. Useful in case the supported features of the device entity changes over the time. |

_\* Required fields_
Expand Down Expand Up @@ -83,6 +84,7 @@ This allows you to control media players. It supports volume, play/pause and ski
| `delay` | int | [Controller specific](/controllerx/controllers) | Delay in milliseconds that takes between sending the volume up/down instructions. Note that the maximum value is 1000 and if leaving to 0, you might get uncommon behavior. |
| `max_loops` | int | 50 | Maximum number of loops when holding. The loop will stop either with a release action or reaching the `max_loops` value. |
| `hold_release_toggle` | boolean | False | If `true`, a `hold` action will work as a release when another `hold` is running. This is useful when you have a button with just one action event and you want to use the hold-release feature, then you just need to map that event to a `hold` action. |
| `supported_features` | int | `0b10111111` or `191` | See [below](#supported_features-field) for the explanation. |
| `update_supported_features` | boolean | False | If `true`, it will check the supported features field everytime before calling any call service action. Useful in case the supported features of the device entity changes over the time. |

_\* Required fields_
Expand All @@ -106,6 +108,66 @@ This allows you to control covers. It supports opening/closing and stop covers.
| `cover`\* | string | `group.all_covers` or `cover.kitchen` | The cover (or group of covers) you want to control |
| `open_position` | number | 100 | The open position (between 0 and 100) |
| `close_position` | number | 0 | The close position (between 0 and 100) |
| `supported_features` | int | `0b10111111` or `191` | See [below](#supported_features-field) for the explanation. |
| `update_supported_features` | boolean | False | If `true`, it will check the supported features field everytime before calling any call service action. Useful in case the supported features of the device entity changes over the time. |

_\* Required fields_

### "supported_features" field

This field will override the `supported_features` attribute from the entity (light, media player, etc). By default, ControllerX will check this value from Home Assistant, however, there are times that this attribute does not reflect properly the features that the entity supports. ControllerX automatically will select one action or another depending on this value, this is why it's important that reflects the supported features. This is defined as a bit field in Home Assistant, so its binary representation of the number will defined which features it supports. You can see the values for each entity below.

#### Light

| feature | value |
| ----------- | ----- |
| BRIGHTNESS | 1 |
| COLOR_TEMP | 2 |
| EFFECT | 4 |
| FLASH | 8 |
| COLOR | 16 |
| TRANSITION | 32 |
| WHITE_VALUE | 128 |

If you want to express support for everything, the value is `0b10111111` or `191`.

#### Media player

| feature | value |
| -------------------- | ------ |
| PAUSE | 1 |
| SEEK | 2 |
| VOLUME_SET | 4 |
| VOLUME_MUTE | 8 |
| PREVIOUS_TRACK | 16 |
| NEXT_TRACK | 32 |
| TURN_ON | 128 |
| TURN_OFF | 256 |
| PLAY_MEDIA | 512 |
| VOLUME_STEP | 1024 |
| SELECT_SOURCE | 2048 |
| STOP | 4096 |
| CLEAR_PLAYLIST | 8192 |
| PLAY | 16384 |
| SHUFFLE_SET | 32768 |
| SELECT_SOUND_MODE | 65536 |
| SUPPORT_BROWSE_MEDIA | 131072 |
| SUPPORT_REPEAT_SET | 262144 |
| SUPPORT_GROUPING | 524288 |

If you want to express support for everything, the value is `0b1111111111110111111` or `524223`.

#### Cover

| feature | value |
| ------------------ | ----- |
| OPEN | 1 |
| CLOSE | 2 |
| SET_COVER_POSITION | 4 |
| STOP | 8 |
| OPEN_TILT | 16 |
| CLOSE_TILT | 32 |
| STOP_TILT | 64 |
| SET_TILT_POSITION | 128 |

If you want to express support for everything, the value is `0b11111111` or `255`.
19 changes: 19 additions & 0 deletions tests/integ_tests/supported_features_field/arrow_hold_test.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# The light theorically supports xy_color, but since we are overriding the value
# from configuration, ControllerX should send color_temp and not xy_color
# because light_mode is auto.
entity_state_attributes:
supported_features: 0b1111111 # Everything supported from the device
color_temp: 200
entity_state: "on"
fired_actions: [arrow_right_hold, 0.450, arrow_right_release]
expected_calls:
- service: light/turn_on
data:
entity_id: light.bedroom
transition: 0.35
color_temp: 234.7
- service: light/turn_on
data:
entity_id: light.bedroom
transition: 0.35
color_temp: 269.4
7 changes: 7 additions & 0 deletions tests/integ_tests/supported_features_field/config.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
livingroom_controller:
module: controllerx
class: E1810Controller
controller: sensor.livingroom_controller_action
integration: z2m
light: light.bedroom
supported_features: 0b1101111 # Everything except xy_color

0 comments on commit c4328a9

Please sign in to comment.