Custom-card "Lock"¶
This is a custom-card that works in switch logic with a lock entity. Card structure uses lock, unlock (optional open) actions and lock,unlock,locking,unlocking, jammed states.
Credits¶
Author: eraycetinay - 2022 Version: 0.0.3
Changelog¶
0.0.3
- Now can displays a warning when the battery is low.
- Now can displays a warning when the door is lock but the door is still open.
- Code refactoring to fit framework structure.
- Documentation clean up.
- Code clean up.
Contributor: Sisimomo - 2022-06-14
0.0.2
Added option to only use lock.open0.0.1
Initial releaseUsage¶
- type: "custom:button-card"
entity: lock.door_lock
template: "custom_card_eraycetinay_lock"
name: "Door Lock"
variables:
ulm_custom_card_eraycetinay_lock_tap_control: true
ulm_custom_card_eraycetinay_lock_battery_level: sensor.door_battery
ulm_custom_card_eraycetinay_lock_door_open: binary_sensor.door_open
triggers_update:
- "sensor.door_battery"
- "binary_sensor.door_open"
Variables¶
| Variable | Example | Default | Required | Explanation |
|---|---|---|---|---|
| ulm_custom_card_eraycetinay_lock_tap_control | true | false | no | Lock/Unlock on tap action |
| ulm_custom_card_eraycetinay_lock_only_open | true | false | no | Only use the card to open the door (always sends lock.open on tap) |
| ulm_custom_card_eraycetinay_lock_battery_level | sensor.door_battery | no | Displays a warning when the battery is low. | |
| ulm_custom_card_eraycetinay_lock_battery_warning | 25 | 20 | no | At what battery percentage should the low battery warning appear. |
| ulm_custom_card_eraycetinay_lock_battery_warning_low | 10 | 5 | no | At what battery percentage should the very low battery warning appear. |
| ulm_custom_card_eraycetinay_lock_door_open | binary_sensor.door_open | no | Displays a warning when the door is lock but the door is still open. | |
| ulm_custom_card_eraycetinay_lock_battery_sensor_binary | true | false | no | Set to true if using a binary battery sensor. Will ignore battery_warning percentage settings |
| ulm_custom_card_eraycetinay_lock_battery_sensor_binary_low_state | off | on | no | Set whether the binary sensor turns to on or off when in low state |
Template Code
custom_card_eraycetinay_lock.yaml
---
custom_card_eraycetinay_lock:
template:
- "icon_info_bg"
- "ulm_translation_engine"
- "custom_card_eraycetinay_lock_language_variables"
variables:
ulm_custom_card_eraycetinay_lock_battery_warning: 20
ulm_custom_card_eraycetinay_lock_battery_warning_low: 5
ulm_custom_card_eraycetinay_lock_battery_sensor_binary: false
ulm_custom_card_eraycetinay_lock_battery_sensor_binary_low_state: "on"
tap_action:
action: |
[[[
return variables.ulm_custom_card_eraycetinay_lock_tap_control ? "call-service" : "more-info";
]]]
# only related with call-service action
service: |
[[[
if(variables.ulm_custom_card_eraycetinay_lock_tap_control){
if(variables.ulm_custom_card_eraycetinay_lock_open){
return "lock.open";
} else {
if (entity.state == "locked"){
return "lock.unlock";
} else if (entity.state == "unlocked"){
return "lock.lock";
}
}
}
]]]
# only related with call-service action
service_data:
entity_id: |
[[[ return entity.entity_id; ]]]
show_label: true
show_name: true
triggers_update:
- "[[[ return entity.entity_id; ]]]"
label: "[[[ return variables.ulm_translation_state ]]]"
state:
- operator: "template"
value: |
[[[ return entity.state == ("unlocked" || "open" || "opened"); ]]]
styles:
icon:
- color: "rgba(var(--color-yellow),1)"
img_cell:
- background-color: "rgba(var(--color-yellow), 0.2)"
- operator: "template"
value: |
[[[ return entity.state == "locked" || "closed"; ]]]
styles:
icon:
- color: "rgba(var(--color-green),1)"
img_cell:
- background-color: "rgba(var(--color-green), 0.2)"
styles:
icon:
- color: "rgba(var(--color-theme),0.2)"
img_cell:
- background-color: "rgba(var(--color-theme),0.05)"
- border-radius: "50%"
- place-self: "center"
- width: "42px"
- height: "42px"
grid:
- position: "relative"
custom_fields:
notification_locked_and_opened:
- border-radius: "50%"
- position: "absolute"
- left: "28px"
- top: "-6px"
- height: "16px"
- width: "16px"
- border: "2px solid var(--card-background-color)"
- font-size: "12px"
- line-height: "14px"
- background-color: "[[[ return 'rgba(var(--color-red),1)'; ]]]"
notification_battery:
- border-radius: "50%"
- position: "absolute"
- left: "-6px"
- top: "-6px"
- height: "16px"
- width: "16px"
- border: "2px solid var(--card-background-color)"
- font-size: "12px"
- line-height: "14px"
- background-color: |
[[[
if (variables.ulm_custom_card_eraycetinay_lock_battery_level !== undefined) {
if (variables.ulm_custom_card_eraycetinay_lock_battery_sensor_binary) {
if (states[variables.ulm_custom_card_eraycetinay_lock_battery_level].state == variables.ulm_custom_card_eraycetinay_lock_battery_sensor_binary_low_state) {
return "rgba(var(--color-red),1)";
}
} else {
if (states[variables.ulm_custom_card_eraycetinay_lock_battery_level].state <= variables.ulm_custom_card_eraycetinay_lock_battery_warning_low) {
return "rgba(var(--color-red),1)";
} else if (states[variables.ulm_custom_card_eraycetinay_lock_battery_level].state <= variables.ulm_custom_card_eraycetinay_lock_battery_warning) {
return "rgba(var(--color-yellow),1)";
}
}
}
]]]
custom_fields:
notification_locked_and_opened: >
[[[
if (variables.ulm_custom_card_eraycetinay_lock_door_open !== undefined && (entity.state === "locked" && states[variables.ulm_custom_card_eraycetinay_lock_door_open].state === "on")) {
return `<span title="${variables.ulm_custom_card_eraycetinay_lock_locked_and_opened}"><ha-icon icon="mdi:door-open" style="width: 12px; height: 12px; color: var(--primary-background-color);"></ha-icon></span>`;
}
]]]
notification_battery: >
[[[
if (variables.ulm_custom_card_eraycetinay_lock_battery_level !== undefined) {
if (variables.ulm_custom_card_eraycetinay_lock_battery_sensor_binary) {
if (states[variables.ulm_custom_card_eraycetinay_lock_battery_level].state == variables.ulm_custom_card_eraycetinay_lock_battery_sensor_binary_low_state) {
return `<span title="${variables.ulm_custom_card_eraycetinay_lock_battery_is_low}">
<ha-icon icon="mdi:battery-low" style="width: 12px; height: 12px; color: var(--primary-background-color);"></ha-icon>
</span>`;
}
} else {
if (variables.ulm_custom_card_eraycetinay_lock_battery_warning >= states[variables.ulm_custom_card_eraycetinay_lock_battery_level].state) {
return `<span title="${variables.ulm_custom_card_eraycetinay_lock_battery_is_at} ${states[variables.ulm_custom_card_eraycetinay_lock_battery_level].state}%">
<ha-icon icon="mdi:battery-low" style="width: 12px; height: 12px; color: var(--primary-background-color);"></ha-icon>
</span>`;
}
}
}
]]]