Merge pull request #36 from mattieha/feat/lock-domain

feat: add support for lock entities

README.md

@@ -2,7 +2,7 @@
 [![GitHub Release][releases-shield]][releases]
 [![hacs_badge](https://img.shields.io/badge/HACS-default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)
 
-A button card with integrated slider for `light, switch, fan, cover, input_boolean, media_player, climate` entities.
+A button card with integrated slider for `light, switch, fan, cover, input_boolean, media_player, climate, lock` entities.
 
 ![Preview][preview]
 
@@ -33,6 +33,7 @@ A button card with integrated slider for `light, switch, fan, cover, input_boole
         - [Cover](#cover)
         - [Media player](#media-player)
         - [Climate](#climate)
+        - [Lock](#lock)
         - [In a grid](#grid)
 - [Known issues](#known-issues)
 - [Languages](#languages)
@@ -68,7 +69,7 @@ Slider Button Card supports Lovelace's Visual Editor.
 | Name              | Type    | Requirement  | Description                                 | Default             |
 | ----------------- | ------- | ------------ | ------------------------------------------- | ------------------- |
 | type              | string  | **Required** | `custom:slider-button-card`                   |
-| entity            | string  | **Required** | HA entity ID from domain `light, switch, fan, cover, input_boolean, media_player, climate`                   |               |
+| entity            | string  | **Required** | HA entity ID from domain `light, switch, fan, cover, input_boolean, media_player, climate, lock`                   |               |
 | name              | string  | **Optional** | Name                                   | `entity.friendly_name`       |
 | show_name        | boolean | **Optional** | Show name  | `true`             |
 | show_state        | boolean | **Optional** | Show state  | `true`             |
@@ -587,6 +588,38 @@ name: Airco
 </tr>
 </table>
 
+#### Lock
+Default behavior: `slider.toggle_on_click: true`
+<table>
+<tr>
+<td></td>
+<td>Action button hidden 
+</td>
+</tr>
+<tr>
+<td><img src="https://raw.githubusercontent.com/mattieha/slider-button-card/main/assets/examples/lock.gif">  
+</td>
+<td valign="top">
+
+```yaml
+type: custom:slider-button-card
+entity: lock.virtual_lock
+slider:
+  direction: left-right
+  background: solid
+  toggle_on_click: true
+icon:
+  use_state_color: true
+  tap_action:
+    action: more-info
+action_button:
+  show: false
+name: Lock
+```  
+</td>
+</tr>
+</table>
+
 #### Grid
 
 <table>

src/controllers/get-controller.ts

@@ -6,6 +6,7 @@ import { CoverController } from './cover-controller';
 import { FanController } from './fan-controller';
 import { InputBooleanController } from './input-boolean-controller';
 import { LightController } from './light-controller';
+import { LockController } from './lock-controller';
 import { MediaController } from './media-controller';
 import { SwitchController } from './switch-controller';
 
@@ -20,6 +21,7 @@ export class ControllerFactory {
       [Domain.INPUT_BOOLEAN]: InputBooleanController,
       [Domain.MEDIA_PLAYER]: MediaController,
       [Domain.CLIMATE]: ClimateController,
+      [Domain.LOCK]: LockController,
     };
     if (typeof mapping[domain] === 'undefined') {
       throw new Error(`Unsupported entity type: ${domain}`)

src/controllers/lock-controller.ts

@@ -0,0 +1,35 @@
+import { STATES_OFF } from 'custom-card-helpers';
+import { Controller } from './controller';
+
+export class LockController extends Controller {
+  _min = 0;
+  _max = 1;
+  _targetValue;
+  _invert = false;
+
+  get _value(): number {
+    return !STATES_OFF.includes(this.stateObj.state)
+      ? 1
+      : 0;
+  }
+
+  set _value(value) {
+    const service = value > 0 ? 'lock' : 'unlock';
+    this._hass.callService('lock', service, {
+      // eslint-disable-next-line @typescript-eslint/camelcase
+      entity_id: this.stateObj.entity_id
+    });
+  }
+
+  get _step(): number {
+    return 1;
+  }
+
+  get label(): string {
+    if (this.percentage > 0) {
+      return this._hass.localize('component.lock.state._.unlocked');
+    }
+    return this._hass.localize('component.lock.state._.locked');
+  }
+
+}

src/types.ts

@@ -79,6 +79,7 @@ export enum Domain {
   INPUT_BOOLEAN = 'input_boolean',
   MEDIA_PLAYER = 'media_player',
   CLIMATE = 'climate',
+  LOCK = 'lock',
 }
 
 export const ActionButtonConfigDefault: ActionButtonConfig = {
@@ -165,6 +166,15 @@ export const SliderConfigDefaultDomain: Map<string, SliderConfig> = new Map([
     toggle_on_click: false,
     force_square: false,
   }],
+  [Domain.LOCK, {
+    direction: SliderDirections.LEFT_RIGHT,
+    background: SliderBackground.SOLID,
+    use_state_color: false,
+    use_percentage_bg_opacity: false,
+    show_track: false,
+    toggle_on_click: true,
+    force_square: false,
+  }],
   [Domain.CLIMATE, {
     direction: SliderDirections.LEFT_RIGHT,
     background: SliderBackground.TRIANGLE,