Skip to content

Commit

Permalink
docs: update Elmo/IESS references with the latest screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
palazzem committed Sep 11, 2023
1 parent 8ac9118 commit ad909a8
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 22 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ If you are curious about the project and want to know more, check out our [Disco
folder so that the full path from your config folder is `custom_components/elmo_iess_alarm/`
3. Restart Home Assistant. If it's your only custom component you'll see a warning in your logs.
4. Once Home Assistant is started, from the UI go to Configuration > Integrations > Add Integrations. Search for
"E-connect Alarm". After selecting, dependencies will be downloaded and it could take up to a minute.
"Elmo/IESS Alarm". After selecting, dependencies will be downloaded and it could take up to a minute.

### Setup

<img src="https://github-production-user-asset-6210df.s3.amazonaws.com/1560405/267038244-a5a590f3-8982-4f01-8ad0-5e7b00222643.png" width="400">
<img src="https://github.com/palazzem/ha-econnect-alarm/assets/1560405/7f2c3eee-cbf7-457c-8fe0-f586ecf0d9f5" width="400">

- Username: is your username to access Elmo/IESS via web or app.
- Password: is your password to access Elmo/IESS via web or app.
Expand All @@ -55,18 +55,22 @@ If you are curious about the project and want to know more, check out our [Disco

### Options

<img src="https://github.com/palazzem/ha-econnect-alarm/assets/1560405/1e99bf57-a29f-4a33-b503-56d3af6b0169" width="400"/>
In the option page you can configure your alarm presets in case you want to fine-tune which sectors are armed. To proceed with the configuration,
open the integration page and click on Elmo/IESS integration. Once the page is opened, you should see the following integration page:

From the integration page, you can configure some options to alter the integration behavior. Click on "Options".
<img src="https://github.com/palazzem/ha-econnect-alarm/assets/1560405/57b12985-b960-46b1-bd0f-188eaa090466" width="400"/>

<img src="https://github.com/palazzem/ha-econnect-alarm/assets/1560405/1469369b-ca95-4ae7-9a67-fd6ca8fbb21d" width="400"/>
To configure the integration, click on "Configure".

- Armed areas while at home (optional): list areas you want to arm when you select Arm Home. If not set, that mode is not
available and no actions are taken when you click the button.
- Armed areas at night (optional): list areas you want to arm when you select Arm Night. If not set, that mode is not available
and no actions are taken when you click the button.
- Armed areas on vacation (optional): list areas you want to arm when you select Arm Vacation. If not set, that mode is not available
and no actions are taken when you click the button.
<img src="https://github.com/palazzem/ha-econnect-alarm/assets/1560405/d82f1fd6-8cbd-47cf-b0b2-d920a28abdf0" width="400"/>


You can now define your presets:
- Armed areas while at home: list areas you want to arm when you select Arm Home.
- Armed areas at night (optional): list areas you want to arm when you select Arm Night.
- Armed areas on vacation (optional): list areas you want to arm when you select Arm Vacation.

In case you don't define any sector for a given preset, no actions are taken when you use the preset from your alarm panel.

### Automations

Expand Down
4 changes: 2 additions & 2 deletions custom_components/elmo_iess_alarm/config_flow.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ async def async_step_user(self, user_input=None):
_LOGGER.error("Unexpected exception %s", err)
errors["base"] = "unknown"
else:
return self.async_create_entry(title="E-connect Alarm", data=user_input)
return self.async_create_entry(title="Elmo/IESS Alarm", data=user_input)

# Populate with latest changes
user_input = user_input or {}
Expand Down Expand Up @@ -117,7 +117,7 @@ async def async_step_init(self, user_input=None):
_LOGGER.error("Unexpected exception %s", err)
errors["base"] = "unknown"
else:
return self.async_create_entry(title="E-connect Alarm", data=user_input)
return self.async_create_entry(title="Elmo/IESS Alarm", data=user_input)

# Populate with latest changes or previous settings
user_input = user_input or {}
Expand Down
6 changes: 3 additions & 3 deletions custom_components/elmo_iess_alarm/strings.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
"username": "[%key:common::config_flow::data::username%]",
"password": "[%key:common::config_flow::data::password%]"
},
"description": "Insert your username and password to gain access. You can configure the system selecting \"Options\" after installing the integration.",
"title": "Configure your e-Connect/IESS system"
"description": "Provide your credentials and the domain used to access your login page via web.\n\nFor instance, if you access to `https://connect.elmospa.com/vendor/`, you must set the domain to `vendor`. In case you don't have a vendor defined, set it to `default`.\n\nYou can configure the system selecting \"Options\" after installing the integration.",
"title": "Configure your Elmo/IESS system"
}
},
"error": {
Expand All @@ -34,7 +34,7 @@
"areas_arm_vacation": "Armed areas when you are on vacation (e.g. 3,4 - optional)"
},
"description": "Define sectors you want to arm in different modes.",
"title": "Configure your e-Connect/IESS system"
"title": "Configure your Elmo/IESS system"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions custom_components/elmo_iess_alarm/translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"password": "Password"
},
"description": "Provide your credentials and the domain used to access your login page via web.\n\nFor instance, if you access to `https://connect.elmospa.com/vendor/`, you must set the domain to `vendor`. In case you don't have a vendor defined, set it to `default`.\n\nYou can configure the system selecting \"Options\" after installing the integration.",
"title": "Configure your e-Connect/IESS system"
"title": "Configure your Elmo/IESS system"
}
}
},
Expand All @@ -34,7 +34,7 @@
"areas_arm_vacation": "Armed areas when you are on vacation (e.g. 3,4 - optional)"
},
"description": "Define sectors you want to arm in different modes.",
"title": "Configure your e-Connect/IESS system"
"title": "Configure your Elmo/IESS system"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions custom_components/elmo_iess_alarm/translations/it.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"password": "Password"
},
"description": "Fornisci le tue credenziali e il dominio utilizzato per accedere alla tua pagina di login via web.\n\nAd esempio, se accedi a `https://connect.elmospa.com/installatore/`, devi impostare il dominio su `installatore`. Nel caso in cui non hai un installatore definito, impostalo su `default`.\n\nPuoi configurare il sistema selezionando \"Opzioni\" dopo aver installato l'integrazione.",
"title": "Configura il tuo sistema e-Connect/IESS"
"title": "Configura il tuo sistema Elmo/IESS"
}
}
},
Expand All @@ -34,7 +34,7 @@
"areas_arm_vacation": "Settori armati quando sei in vacanza (es. 3,4 - opzionale)"
},
"description": "Definisci i settori che desideri armare in diverse modalità.",
"title": "Configura il tuo sistema e-Connect/IESS"
"title": "Configura il tuo sistema Elmo/IESS"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions tests/test_config_flow.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ async def test_form_submit_successful(mock_client, mock_setup_entry, mock_setup,
await hass.async_block_till_done()

assert result["type"] == "create_entry"
assert result["title"] == "E-connect Alarm"
assert result["title"] == "Elmo/IESS Alarm"
assert result["data"] == {
"username": "test-username",
"password": "test-password",
Expand Down Expand Up @@ -76,7 +76,7 @@ async def test_form_submit_with_defaults(mock_client, mock_setup_entry, mock_set
await hass.async_block_till_done()

assert result["type"] == "create_entry"
assert result["title"] == "E-connect Alarm"
assert result["title"] == "Elmo/IESS Alarm"
assert result["data"] == {
"username": "test-username",
"password": "test-password",
Expand Down

0 comments on commit ad909a8

Please sign in to comment.