Skip to content

change pending_time to arming_time #12530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
starkillerOG wants to merge 13 commits into from
Closed

change pending_time to arming_time #12530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a93886f
Add Netatmo webhook event examples (#12494)
cgtobi Mar 24, 2020
d400dff
Bump remark-frontmatter from 1.3.2 to 1.3.3 (#12501)
dependabot-preview[bot] Mar 24, 2020
a8d3301
0.107.6 (#12502)
pvizeli Mar 24, 2020
5aaaf0e
Fix indentation in recorder.markdown (#12504)
domoritz Mar 24, 2020
bc629df
Add model RU7172, cleanup model list (#12509)
KarlKl Mar 25, 2020
e825379
Bump remark-lint from 6.0.5 to 6.0.6 (#12513)
dependabot-preview[bot] Mar 25, 2020
b224270
Bump remark-lint-no-shell-dollars from 1.0.3 to 1.0.4 (#12512)
dependabot-preview[bot] Mar 25, 2020
473fa08
Bump remark-lint-fenced-code-flag from 1.0.3 to 1.0.4 (#12511)
dependabot-preview[bot] Mar 25, 2020
714d036
Release 107.7
balloob Mar 26, 2020
ab73900
rfxtrx.markdown (#12517)
The2rB Mar 26, 2020
544e290
Adding Core (#12522)
DubhAd Mar 27, 2020
52e0cbd
Fixing YAML parameters (#12520)
dontbug Mar 27, 2020
209077b
change pending_time to arming_time
starkillerOG Mar 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 107
current_patch_version: 5
date_released: 2020-03-21
current_patch_version: 7
date_released: 2020-03-25

# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
Expand Down
36 changes: 18 additions & 18 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
"dependencies": {},
"devDependencies": {
"remark-cli": "^7.0.1",
"remark-frontmatter": "^1.3.2",
"remark-lint": "^6.0.5",
"remark-lint-fenced-code-flag": "^1.0.3",
"remark-lint-no-shell-dollars": "^1.0.3",
"remark-frontmatter": "^1.3.3",
"remark-lint": "^6.0.6",
"remark-lint-fenced-code-flag": "^1.0.4",
"remark-lint-no-shell-dollars": "^1.0.4",
"remark-stringify": "^7.0.4",
"textlint": "^11.6.3",
"textlint-rule-common-misspellings": "^1.0.1",
Expand Down
26 changes: 13 additions & 13 deletions source/_docs/installation/raspberry-pi.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Manual installation on a Raspberry Pi"
description: "Instructions to install Home Assistant on a Raspberry Pi running Raspbian Lite."
description: "Instructions to install Home Assistant Core on a Raspberry Pi running Raspbian Lite."
redirect_from: /getting-started/installation-raspberry-pi/
---

This installation of Home Assistant requires the Raspberry Pi to run [Raspbian Lite](https://www.raspberrypi.org/downloads/raspbian/). The installation will be installed in a [Virtual Environment](/docs/installation/virtualenv) with minimal overhead. Instructions assume this is a new installation of Raspbian Lite.
This installation of Home Assistant Core requires the Raspberry Pi to run [Raspbian Lite](https://www.raspberrypi.org/downloads/raspbian/). The installation will be installed in a [Virtual Environment](/docs/installation/virtualenv) with minimal overhead. Instructions assume this is a new installation of Raspbian Lite.

You must have Python 3.7 or later installed (including the package `python3-dev`) which is *not* the case for Raspbian Stretch.

Expand Down Expand Up @@ -44,22 +44,22 @@ Install the dependencies.
sudo apt-get install python3 python3-dev python3-venv python3-pip libffi-dev libssl-dev
```

Add an account for Home Assistant called `homeassistant`.
Since this account is only for running Home Assistant the extra arguments of `-rm` is added to create a system account and create a home directory. The arguments `-G dialout,gpio,i2c` adds the user to the `dialout`, `gpio` and the `i2c` group. The first is required for using Z-Wave and Zigbee controllers, while the second is required to communicate with Raspberry's GPIO.
Add an account for Home Assistant Core called `homeassistant`.
Since this account is only for running Home Assistant Core the extra arguments of `-rm` is added to create a system account and create a home directory. The arguments `-G dialout,gpio,i2c` adds the user to the `dialout`, `gpio` and the `i2c` group. The first is required for using Z-Wave and Zigbee controllers, while the second is required to communicate with Raspberry's GPIO.

```bash
sudo useradd -rm homeassistant -G dialout,gpio,i2c
```

Next we will create a directory for the installation of Home Assistant and change the owner to the `homeassistant` account.
Next we will create a directory for the installation of Home Assistant Core and change the owner to the `homeassistant` account.

```bash
cd /srv
sudo mkdir homeassistant
sudo chown homeassistant:homeassistant homeassistant
```

Next up is to create and change to a virtual environment for Home Assistant. This will be done as the `homeassistant` account.
Next up is to create and change to a virtual environment for Home Assistant Core. This will be done as the `homeassistant` account.

```bash
sudo -u homeassistant -H -s
Expand All @@ -73,13 +73,13 @@ Once you have activated the virtual environment (notice the prompt change to `(h
python3 -m pip install wheel
```

Once you have installed the required Python package it is now time to install Home Assistant!
Once you have installed the required Python package it is now time to install Home Assistant Core!

```bash
pip3 install homeassistant
```

Start Home Assistant for the first time. This will complete the installation for you, automatically creating the `.homeassistant` configuration directory in the `/home/homeassistant` directory, and installing any basic dependencies.
Start Home Assistant Core for the first time. This will complete the installation for you, automatically creating the `.homeassistant` configuration directory in the `/home/homeassistant` directory, and installing any basic dependencies.

```bash
hass
Expand All @@ -92,23 +92,23 @@ When you run the `hass` command for the first time, it will download, install an

</div>

If you want to setup `hass` as a daemon and autostart it on boot please refer to [Autostart Home Assistant](/docs/autostart/).
If you want to setup `hass` as a daemon and autostart it on boot please refer to [Autostart Home Assistant Core](/docs/autostart/).

### Updating

To update to the latest version of Home Assistant follow these simple steps:
To update to the latest version of Home Assistant Core follow these simple steps:

```bash
sudo -u homeassistant -H -s
source /srv/homeassistant/bin/activate
pip3 install --upgrade homeassistant
```

Once the last command executes, restart the Home Assistant service to apply the latest updates. Please keep in mind that some updates may take longer to start up than others. If Home Assistant fails to start, make sure you check the **Breaking Changes** from the [Release Notes](https://github.com/home-assistant/home-assistant/releases).
Once the last command executes, restart the Home Assistant Core service to apply the latest updates. Please keep in mind that some updates may take longer to start up than others. If Home Assistant Core fails to start, make sure you check the **Breaking Changes** from the [Release Notes](https://github.com/home-assistant/home-assistant/releases).

### Run a specific version

In the event that a Home Assistant version doesn't play well with your hardware setup, you can downgrade to a previous release. For example:
In the event that a Home Assistant Core version doesn't play well with your hardware setup, you can downgrade to a previous release. For example:

```bash
sudo -u homeassistant -H -s
Expand All @@ -128,7 +128,7 @@ pip3 install --pre --upgrade homeassistant

### Run the development version

If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`.
If you want to stay on the bleeding-edge Home Assistant Core development branch, you can upgrade to `dev`.

<div class='note warning'>
The "dev" branch is likely to be unstable. Potential consequences include loss of data and instance corruption.
Expand Down
42 changes: 20 additions & 22 deletions source/_integrations/manual.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,17 @@ code_arm_required:
type: boolean
default: true
delay_time:
description: The time in seconds of the pending time before triggering the alarm.
description: The time in seconds of the 'pending' state before triggering the alarm.
required: false
type: integer
default: 0
pending_time:
description: The time in seconds of the pending time before effecting a state change.
arming_time:
description: The time in seconds of the 'arming' state before effecting a state change.
required: false
type: integer
default: 60
trigger_time:
description: The time in seconds of the trigger time in which the alarm is firing.
description: The time in seconds of the 'triggered' state in which the alarm is firing.
required: false
type: integer
default: 120
Expand All @@ -73,8 +73,8 @@ armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered:
description: State specific setting for **delay_time** (all states except **triggered**)
required: false
type: integer
pending_time:
description: State specific setting for **pending_time** (all states except **disarmed**)
arming_time:
description: State specific setting for **arming_time** (all states except **disarmed**)
required: false
type: integer
trigger_time:
Expand All @@ -86,21 +86,20 @@ armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered:
## State machine

The state machine of the manual alarm integration is complex but powerful. The
transitions are timed according to three values, **delay_time**, **pending_time**
and **trigger_time**. The values in turn can come from the default configuration
transitions are timed according to three values, **delay_time**, **arming_time**
and **trigger_time**. The values in turn can come from the default configuration
variable or from a state-specific override.

When the alarm is armed, its state first goes to **pending** for a number
of seconds equal to the destination state's **pending_time**, and then
When the alarm is armed, its state first goes to **arming** for a number
of seconds equal to the destination state's **arming_time**, and then
transitions to one of the "armed" states. Note that **code_template**
never receives "pending" in the **to_state** variable; instead,
never receives "arming" in the **to_state** variable; instead,
**to_state** contains the state which the user has requested. However,
**from_state** *can* contain "pending".
**from_state** *can* contain "arming".

When the alarm is triggered, its state goes to **pending** for a number of
seconds equal to the previous state's **delay_time** plus the triggered
state's **pending_time**. Then the alarm transitions to the "triggered"
states. The code is never checked when triggering the alarm, so the
seconds equal to the previous state's **delay_time**. Then the alarm transitions to the "triggered"
states. The code is never checked when triggering the alarm, so the
**to_state** variable of **code_template** cannot ever contain "triggered"
either; again, **from_state** *can* contain "triggered".

Expand All @@ -110,12 +109,11 @@ it goes back to either the previous state or **disarmed**. If the previous
state's **trigger_time** is zero, the transition to "triggered" is entirely
blocked and the alarm remains in the armed state.

Each of the settings is useful in different scenarios. **pending_time** gives
you some time to leave the building (for "armed" states) or to disarm the alarm
(for the "triggered" state).
Each of the settings is useful in different scenarios. **arming_time** gives
you some time to leave the building (for "armed" states).

**delay_time** can also be used to allow some time to disarm the alarm, but with
more flexibility. For example, you could specify a delay time for the
**delay_time** can be used to allow some time to disarm the alarm, with
flexibility. For example, you could specify a delay time for the
"armed away" state, in order to avoid triggering the alarm while the
garage door opens, but not for the "armed home" state.

Expand All @@ -136,13 +134,13 @@ alarm_control_panel:
- platform: manual
name: Home Alarm
code: 1234
pending_time: 30
arming_time: 30
delay_time: 20
trigger_time: 4
disarmed:
trigger_time: 0
armed_home:
pending_time: 0
arming_time: 0
delay_time: 0
```

Expand Down
Loading