Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nielsfaber/alarmo-card
Home Assistant card for controlling the Alarmo component
https://github.com/nielsfaber/alarmo-card
alarm alarmo assistant card home home-assistant lovelace security
Last synced: 11 days ago
JSON representation
Home Assistant card for controlling the Alarmo component
- Host: GitHub
- URL: https://github.com/nielsfaber/alarmo-card
- Owner: nielsfaber
- Created: 2021-07-31T14:04:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-16T02:55:23.000Z (3 months ago)
- Last Synced: 2024-10-23T08:31:00.286Z (19 days ago)
- Topics: alarm, alarmo, assistant, card, home, home-assistant, lovelace, security
- Language: TypeScript
- Homepage:
- Size: 549 KB
- Stars: 109
- Watchers: 6
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# alarmo-card
[](https://github.com/hacs/integration)
- [alarmo-card ](#alarmo-card-)
- [Introduction](#introduction)
- [Features](#features)
- [Countdown timer](#countdown-timer)
- [Diagnostics messages](#diagnostics-messages)
- [Arming options](#arming-options)
- [Card customization](#card-customization)
- [Installation](#installation)
- [Updating](#updating)
- [Configuration](#configuration)
- [Options](#options)
- [State configuration](#state-configuration)
- [Say thank you](#say-thank-you)
## Introduction
This is a Lovelace card for Home Assistant that can be used to control your Alarmo security system.
The card works on top of the [alarmo custom component](https://github.com/nielsfaber/alarmo). You *will* need it this as well.
This card is only suitable for controlling entities (of type `alarm_control_panel`) which are generated by the Alarmo integration, you cannot use it with any other alarm integration in HA.
Preview:
## Features
The alarmo-card is similar to the [Lovelace alarm panel card](https://www.home-assistant.io/lovelace/alarm-panel/), but brings some extra functions.
### Countdown timer
A countdown timer is displayed when the alarm is in arming or pending state.
The countdown timer will show the remaining time of the configured exit / entry delay.
This gives you an indication of how much time you have left for leaving the house / disarming the alarm.
### Diagnostics messages
The card will give you an indication in the following conditions:
* A wrong code (or no code) was entered.
* The alarm could not be armed (due to one or more sensors).
* The alarm was triggered (due to one or more sensors).
In the second and third case you will see a message in the card with the sensors that caused the issue.
The state of these sensors is visible in the message, such that you have feedback in case the issue is resolved.
### Arming options
When the alarm is disabled, an icon is shown in the top-right corner of the card. By clicking it a menu is revealed with the advanced arming options:
* *Skip delay*: setting this option will cause the exit delay to be skipped, so arming the alarm will be effective immediately. This is practical in case you want to arm the alarm after you already left the house.
* *Bypass open sensors*: this option forces the alarm to be armed. In case sensors are blocking the arming, they will be automatically bypassed (temporarily eliminated from the alarm).
The arming options are only applied on the next time you arm the alarm.
### Card customization
The card allows the following customization options:
* Increasing the size of the buttons in the card.
* Choose which buttons for arming modes are visible.
* Change the texts visible on the arming mode buttons and the text visible when the alarm is in this state.
* Change the title of the alarm.
## Installation
click to show installation instructions
HACS installation:
Note: Ensure you have a www folder created as in config/www or the installation will succeed but fails silently
1. Click the Orange + button bottom right and search for Alarmo Card
2. Click on "Install" under the new card that just popped up.
Note: Ensure to install [`https://github.com/nielsfaber/alarmo`](https://github.com/nielsfaber/alarmo) and add the integration in order for the card to work properly.
Manual installation
1. Download the latest release of `alarmo-card.js` [here](https://github.com/nielsfaber/alarmo-card/releases) and place it into `www/alarmo-card`.
2. Use the GUI; Configuration -> Lovelace Dashboards -> Resources Tab to add `/local/alarmo-card/alarmo-card.js?v=0`, or add a reference to the card in the resources section of `configuration.yaml`:
```yaml
resources:
- url: /local/alarmo-card/alarmo-card.js?v=0
type: module
```
## Updating
click to show updating instructions
Updating via HACS:
HACS should auto-remind you in the HACS tab when an update is available.
Updating manually:
Use `git pull` for manual installation updates.
Since most browsers will cache the Lovelace card code, you can force a refresh of the browser by editing the entry in the `resources:` section in `ui-lovelace.yaml`, by updating the version to `?v=(n+1)` (where `n` the current value).
---
## Configuration
For setting up the card, you need to assign the correct entity to the card.
All settings regarding delay times, arming modes, code settings are automatically detected.
Example YAML configuration:
```yaml
type: 'custom:alarmo-card'
entity: alarm_control_panel.alarmo
```
Configuration using UI mode:
1. Go to the Lovelace page where you want to add the card
2. Click "Edit Dashboard" on the right (under the button with the 3 dots)
* Click the "Add card" button on the bottom
* Choose "Custom: Alarmo Card" and pick the correct entity.
## Options
| Name | Type | Requirement | Description | Default |
| ----------------------- | ------- | ------------ | -------------------------------------------------------------------------------------------------------------- | ------------------ |
| `type` | string | **Required** | `custom:alarmo-card` | |
| `entity` | string | **Required** | Alarm_control_panel entity | |
| `name` | string | Optional | Displayed name (next to icon) | (Take from entity) |
| `keep_keypad_visible` | boolean | Optional | Keep the keypad always visible, also when no code input is required.
Only useful if numerical code is used. | `false` |
| `button_scale_actions` | number | Optional | Scaling factor to apply to the size of the action buttons (between 1.0 and 2.5) | `1.0` |
| `button_scale_keypad` | number | Optional | Scaling factor to apply to the size of the keypad buttons (between 1.0 and 2.5) | `1.0` |
| `use_clear_icon` | boolean | Optional | Show icon (instead of text) in keypad for clearing code input.
Only useful if numerical code is used. | `false` |
| `show_messages` | boolean | Optional | Show diagnostic messages in the card when alarm is triggered or cannot be armed. | `true` |
| `show_ready_indicator` | boolean | Optional | Adds ready/not ready indicators to the arm mode buttons. | `true` |
| `show_bypassed_sensors` | boolean | Optional | Show a warning message when the alarm is armed with bypassed sensors. | `true` |
| `states` | object | Optional | Customize the display of states in the card.
See [state configuration](#state-configuration). | |
### State configuration
State configuration allows users to modify the displayed texts and buttons (where applicable) in the card corresponding to certain states.
Note that the alarm entity may not support all `armed_xxx` states. States which are not supported will not show up in the card and cannot be configured.
| Name | Type | Applicable states | Description | Default |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------- |
| `hide` | boolean | `armed_away`
`armed_home`
`armed_night`
`armed_vacation`
`armed_custom_bypass` | Hides the button corresponding to the state. | `false` |
| `button_label` | string | `disarmed`
`armed_away`
`armed_home`
`armed_night`
`armed_vacation`
`armed_custom_bypass` | Overwrites the text on the button.
Only useful if the button is not hidden. | (Use translation from HA) |
| `state_label` | string | `disarmed`
`triggered`
`arming`
`pending`
`armed_away`
`armed_home`
`armed_night`
`armed_vacation`
`armed_custom_bypass` | Overwrites the text displayed in the card when the alarm is in this state. | (Use translation from HA) |
**Example of using state configuration**
The example below hides the `armed_home` button (although the alarm supports it), and renames the `armed_away` / `disarmed` options.
```yaml
type: custom:alarmo-card
entity: alarm_control_panel.alarmo
states:
armed_away:
hide: false
button_label: "Turn on"
state_label: "Enabled"
armed_home:
hide: true
disarmed:
hide: false
button_label: "Turn off"
state_label: "Disabled"
# ... rest of card config
```
Result:
---
## Say thank you
If you want to make donation as appreciation of my work, you can do so via PayPal or buy me a coffee. Thank you!
