name of the alarm

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,28 +1,52 @@
 ---
 name: Bug report
 about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
 
 ---
 
+<!-- READ THIS FIRST:
+  - Make sure you are running the latest version of Home Assistant before reporting an issue: https://github.com/akasma74/Hass-Custom-Alarm/releases
+  - Provide as many details as possible. Paste logs, configuration samples and code into the backticks.
+-->
+
+**The component:**
+ - Current version:
+ - Last known working version (if any):
+
+**Your setup:**
+ - Home Assistant version:
+ - Last known working Home Assistant version (if any):
+ - OS:
+ - Browser name & version:
+
 **Describe the bug**
-A clear and concise description of what the bug is.
+<!-- A clear and concise description of what the bug is.-->
 
 **To Reproduce**
+<!--
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
+-->
 
 **Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- A clear and concise description of what you expected to happen. -->
 
+**Your bwalarm.yaml**
+<!-- If applicable, paste content of your config to help explain your problem.  -->
+```yaml
+```
+**Home Assistant log**
+<!-- If applicable, paste messages from Home assistant log related to your problem here.  -->
+```txt
+```
 **Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Browser (please complete the following information):**
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+<!-- If applicable, add screenshots to help explain your problem. -->
 
 **Additional context**
-Add any other context about the problem here.
+<!-- Add any other context about the problem here.<!--

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
 
 ---
 

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+__pycache__

README.md

@@ -1,92 +1,62 @@
-# Home Assistant - Custom Alarm Interface!
-## Intro :-)
+# BWAlarm (ak74 edition)
 
-Welcome my fellow modders, tinkerers, home assistant wizards!!
+## Disclaimer
+This fork was created to maintain the original [bwalarm](https://github.com/gazoscalvertos/Hass-Custom-Alarm) custom component until its author is back.  
+The discussion thread on Home Assistant Community to share ideas or ask for help (NOT to report a bug!) is [here](https://community.home-assistant.io/t/bwalarm-akasma74-edition/113666).  
+Feel free to open a [new issue](https://github.com/akasma74/Hass-Custom-Alarm/issues/new/choose) or make a Pull Request.  
+Any constructive feedback/suggestion is welcome.
 
-Follow the thread [here](https://community.home-assistant.io/t/yet-another-take-on-an-alarm-system/32386)
+## Important!
+Since HA 0.115 until further notice this component no longer has a GUI panel and can only be controlled via automations/MQTT commands/Lovelace Alarm Card. 
 
-Consider donating to this project to keep it going as anything contributed will be placed back in to enable more hardware integration, new features and bug squashing.
-
-This is very much a community project so if you wish to chip in then please do!! I could really use a CSS, animation, design guru to make this look amazing. Also please feel free to leave comments, suggestions, enhancements and fixes!!
-
-**NOTE!!! MAJOR CHANGE** It's time to publish the New UI and settings into the master release.
-
-## Installation
-
-You will need to copy the following files into your home assistant configuration directory
-
-alarm.yaml	*This files stores your alarm configuration. An options page will be created for this file*
-custom_components/alarm_control_panel/bwalarm.py *The brains of the operation. This is the logic of the custom alarm system*
-panels/alarm.html *This is the interface for the custom alarm component. It's actually optional as the alarm will function without it but recommended for ease of setup*
-www/alarm/[ALL FILES] *These files control how the interface looks and feels*
-www/lib/[ALL FILES] *These files add additional functionality to the interface in order to work*
-www/images/ha.png *An image file used for the interface log*
-
-To get things working with Home Assistant (HA) you will need to adjust your configuration.yaml to instruct HA to use your new custom alarm component, add the following to this file:
+## How to: installation
+Manually:  
+Copy the following folders into your home assistant configuration directory:  
 ```
-alarm_control_panel: !include alarm.yaml
+  custom_components/bwalarm/  The alarm system code, resources and documentation there
+  resources                   This folder stores your alarm configuration file and some user data (i.e badges)
 ```
-You will also need to tell HA where your new panel interface file is. Also add the following to your configuration.yaml:
+
+Using [HACS](https://github.com/custom-components/hacs) (you need to have HACS already installed and configured):  
+1. Click on **Community** in the left hand side menu on Home Assistant frontend
+2. Click **Store**
+3. Scroll down until you see _BWAlarm (ak74 edition)_ and  click on it
+4. If necessary, select **Show Beta** from the drop-down menu under **SETTINGS**
+5. Optionally, select version from **Available versions** drop-down list (_it has the latest one selected by default_).
+6. Click **INSTALL** and wait until it's done
+7. **If you don't have `resources` folder in your `<Home Assistant config folder>` folder, you may need to create one**
+8. Save [bwalarm](resources/) folder into your local `<Home Assistant config folder>/resources` folder
+8. [Configure](custom_components/bwalarm/resources/doc/configuration.md) the alarm.
+
+To get things working with Home Assistant (HA) you need to add the following to your `configuration.yaml`:  
 ```
-panel_custom: !include panel_custom.yaml
+alarm_control_panel: !include resources/bwalarm/bwalarm.yaml
 ```
-You may need to restart HA if the component doesn't load first time as HA will need to install a dependency (ruamel.yaml).
+You may need to restart HA if the integration doesn't load first time as HA will need to install a dependency (`ruamel.yaml`).  
 
-It's advisable to start with a new alarm.yaml file with the minimum configuration set:
+It's advisable to start with a new ```bwalarm.yaml``` file (located in ```resources/bwalarm``` folder) with the minimum configuration set:
 ```
 platform: bwalarm
-name: House
 ```
-Your new interface can be used to modify your alarm.yaml directly.
-
-The default password to access the settings page is: **HG28!!&dn**
-
-Please test and provide feedback/suggestions.
-
-### Features:
-- State specific groups and times (NEW)
-- User specific codes
-- Panic Mode
-- MQTT Integration
-- Floorplan Integration
-- Alarm State Persistence on reboots/power restore
-- Lockout of HA sidebar when armed
-- Custom Panel allowing your own html to display whatever you choose (Cameras, Sliding Images etc)
-- Passcode Attemps/Lockout
-- Support for custom device states
-- Code panel 0-9 on disarm only
-- Weather Status (Optional) - **NOTE:** Weather sensor nows supports generic sensors (sensor.weather_summary & sensor.weather_temperature) if these are not found then it will default to the dark sky sensors (sensor.dark_sky_summary & sensor.dark_sky_temperature)
-- Perimeter Mode (Optional) - I use this to only arm a particular set of sensors (doors) whilst I'm using all floors.
-- Masks passcode on entry
-- clock display (Optional)
-- Digit code entry on disarm
-- Themed colours depending on alarm state
-- Countdown timer on 'Pending' state
-- Notification of Open Sensors with the option to override
-- Information/Debug panel
-
-### Change Log:
-- 27/11/18:
-- [FEATURE] Adding some basic error handling which will be enhanced at a later date
-- [FIX BUG] Fixed margin issue in firefox (settings)
-- [REQUEST] Sorted sensors alphabetically
-- [FIX BUG] Fixed clock, serif, weather, passcode display issues
-
-- 22/11/18:
-- Quite a few bugs and issues have been resolved on this release. There has also been a number of changes to the config file layout so you are likely required to start from scratch as the users, themes and panel settings have changed.
-
-- Updated alarm.html to 1.3.3
-- Updated bwalarm.py to 1.1.3
-
-- fixed duplicate sensors in settings panel
-- fixed passcode attempts setting
-- fixed code to arm display issues
-- fixed persistant mode
-- fixed sesnor groups
-- fixed code to arm panel display and alignment
-- reformated logs
-- fixed log (displaying name and image)
-- removed windows line feed
-- integrated HASS users into alarm automatically however these initially are disabled
-- fixed switch breaks on service call
-- fixed themes
+You can always configure your alarm using web interface or by editing your ```bwalarm.yaml``` directly.  
+The default password to access the Settings tab of the panel is **HG28!!&dn**  
+For more details please refer to the [configuration variables](custom_components/bwalarm/resources/doc/configuration.md) page, [examples](custom_components/bwalarm/resources/doc/examples.md) and [notes](custom_components/bwalarm/resources/doc/notes.md).  
+
+## How to: update
+Manually:  
+Currently the update process is pretty much similar to installation:  
+1. Copy a new release archive/clone the repository from GotHub to a local folder on your computer.
+2. You only need to copy `custom_components/bwalarm` folder from the downloaded release into your `<Home Assistant config folder>/custom_components` folder.
+3. Please note that you DON'T need to overwrite `<Home Assistant config folder>/resources` folder as it contains your integration's configuration file (and possibly some additional resources).
+
+Using [HACS](https://github.com/custom-components/hacs):  
+1. Click on **Community** in the left hand side menu on Home Assistant frontend
+2. Click on _BWAlarm (ak74 edition)_ in Integrations
+3. Click **UPGRADE**
+
+**Bear in mind that if you use this method, it only updates `<Home Assistant config folder>/custom_components/bwalarm/` folder and **ALL** user data inside that folder will be lost upon every update!**  
+Updating by using HACS (even if you initially installed the integration manually) does not overwrite user settings as these are stored in the `<Home Assistant config folder>/resources` folder.  
+
+## After update (for all methods)
+Please note that the component's code is loaded on Home Assistant startup and the panels' code (`panel.html`) is cached by a browser.  
+Therefore, **every time you update** no matter how, **you HAVE to clear cache of ALL of your browsers and then RESTART Home Assistant** for changes to take effect.