Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
krkeegan committed Sep 7, 2023
2 parents c8e0ce3 + 4442227 commit 83ce11d
Show file tree
Hide file tree
Showing 41 changed files with 3,049 additions and 1,276 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.1.1
current_version = 1.2.0
commit = True
tag = False

Expand Down
2 changes: 2 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[html]
show_contexts = True
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Revision Change History

## [1.2.0]

### Fixes

- Fix error description #488
- Allow scenes.yaml file to be empty Thanks @kpfleming #497
- Fixes for HomeAssitant changes #505
- Suppress runtime error in Web UI #515
- Change default Friendly Name of devices in Home Assitant Discovery to comply with new standards. If you have defined your own templates, you may need to adjust the name field. See ([HomeAssistant Entity Naming Guidelines](https://developers.home-assistant.io/docs/core/entity/#entity-naming)) ([Change in MQTT Naming](https://github.com/home-assistant/core/pull/95159)) #516
- Fix Bug cuasing switches turned off to be reported as on. Thanks @tstabrawa #517
- Allow for use of mode strings "instant", "fast", "normal" ... as described in the documentation. #519
- Reverse dusk and dawn signal. #520
- Prevent Refresh Commands from piling up on battery devices. Thanks @tstabrawa #521

### Additions

- New improvements to the Home Assistant Discovery Platform system. Now allows for overriding values for an individual device. Thanks @kpfleming ([Documentation](https://github.com/TD22057/insteon-mqtt/blob/master/docs/discovery_customization_config.md))

## [1.1.1]

### Fixes
Expand Down
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,12 @@ integrated into and controlled from anything that can use MQTT.

This package works well with HomeAssistant and can be easily [installed as an addon](docs/HA_Addon_Instructions.md) using the HomeAssistant Supervisor.

Version: 1.1.1 ([History](CHANGELOG.md))
Version: 1.2.0 ([History](CHANGELOG.md))

### Recent Breaking Changes

- 0.9.1 - A Yaml validation routine was added. If you have an error in your
config.yaml file, you will get an error on startup.
- 0.8.3 - HomeAssistant version 2021.4.0 now only supports percentages for fan
speeds. This means any fan entities in HomeAssistant that were configured
to use "low", "medium", and "high" for the fan speed will no longer work.
See [config-example.yaml](https://github.com/TD22057/insteon-mqtt/blob/master/config-example.yaml)
under the `mqtt -> fan` section for a suggest configuration in
HomeAssistant. __Users not using HomeAssistant are unaffected.__
- 0.7.4 - IOLinc, the scene_topic has been elimited, please see the documentation
for the replaces functionality.
- 0.7.2 - KeypadLinc now supports both dimmer and on/off device types. This required
changing the KeypadLinc inputs in the MQTT portion of the config.yaml file.
See the file in the repository for the new input fields. ([Issue #33][I33]).


# Quickstart

Expand All @@ -39,6 +27,9 @@ Using Home Assistant Supervisor?
- [Installation Guide](docs/quick_start.md) - Install from the command line
- [Startup Script](docs/auto_start.md) - Running InsteonMQTT on startup.
- [Install as a HomeAssistant Addon](docs/HA_Addon_Instructions.md) - Install in HomeAssistant
- [Discovery for HomeAssistant](docs/discovery.md) - Automatic entity discovery
- [Customizing HomeAssistant Entities](docs/discovery_customization_ui.md) - Customizing entities in HomeAssistant
- [Discovery Overrides](docs/discovery_customization_config.md) - Alter discovery entities using templates and overrides
- [Configuration](docs/configuration.md) - The base configuration requirements
- [Initialize your Devices](docs/initializing.md) - Setting up your Insteon Devices
- [User Interface Options](docs/user_interface.md) - Three available user interfaces.
Expand Down Expand Up @@ -121,3 +112,17 @@ Thanks to [Insteon terminal](https://github.com/pfrommerd/insteon-terminal),
without the work that went into that repo, it would have taken me
forever to get this to work. I learned all of the command protocols
and database managemenet commands from inspecting that code.

# Old Breaking Changes

- 0.8.3 - HomeAssistant version 2021.4.0 now only supports percentages for fan
speeds. This means any fan entities in HomeAssistant that were configured
to use "low", "medium", and "high" for the fan speed will no longer work.
See [config-example.yaml](https://github.com/TD22057/insteon-mqtt/blob/master/config-example.yaml)
under the `mqtt -> fan` section for a suggest configuration in
HomeAssistant. __Users not using HomeAssistant are unaffected.__
- 0.7.4 - IOLinc, the scene_topic has been elimited, please see the documentation
for the replaces functionality.
- 0.7.2 - KeypadLinc now supports both dimmer and on/off device types. This required
changing the KeypadLinc inputs in the MQTT portion of the config.yaml file.
See the file in the repository for the new input fields. ([Issue #33][I33]).
5 changes: 3 additions & 2 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "Insteon MQTT",
"description": "Creates an MQTT interface to the Insteon protocol.",
"slug": "insteon-mqtt",
"version": "1.1.1",
"version": "1.2.0",
"startup": "services",
"arch": ["amd64","armhf","aarch64","i386"],
"boot": "auto",
Expand All @@ -12,5 +12,6 @@
"schema": {},
"image": "td22057/{arch}-insteon-mqtt",
"ingress": true,
"ingress_port": 8099
"ingress_port": 8099,
"init": false
}
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ added.
# Show lines that need coverage
pytest --cov=insteon_mqtt --cov-report term-missing
# Create html files that show missing lines
pytest --cov=insteon_mqtt --cov-report html
# Create html files that show missing lines and which tests are run on which lines
pytest --cov=insteon_mqtt --cov-report=html --cov-context=test
```

# Logging
Expand Down
10 changes: 9 additions & 1 deletion docs/config_extra.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,15 @@ This key can be used to define a custom discovery template for this device.
The value of this setting should be a subkey under the `mqtt` key in the yaml
config file. This subkey must contain a `discovery_entities` list of each of
the discovery entities. For more details and examples see
[Discovery](https://github.com/TD22057/insteon-mqtt/blob/master/docs/discovery.md).
[Discovery](discovery.md).

### `discovery_override_class` - Discovery Override Class
Details of this setting can be found in [Discovery Customization in
Insteon-MQTT](discovery_customizaton_config.md).

### `discoverable` - Discovery Control
Details of this setting can be found in [Discovery Customization in
Insteon-MQTT](discovery_customizaton_config.md).

## Advanced Settings
These settings can be used with all device types, but should be considered advanced. These settings may cause undesirable effects.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The following is the bare minimum of changes to the `config.yaml` file that are
Starting in version 1.0.0 InsteonMQTT now includes a base configuration file which the user configuration file is overlayed over the top. You should not directly edit the base configuration file, as it will be overwritten during updates. If you want to change a default setting, simply define the same key in your user configuration file and set your desired value.

You can view the contents of the base configuration file here:
[config-base.yaml](https://github.com/TD22057/insteon-mqtt/blob/master/insteon_mqtt/data/config-base.yaml)
[config-base.yaml](../insteon_mqtt/data/config-base.yaml)

Settings in your user config file will replace those in the base config file pursuant to the following rules:

Expand Down
Loading

0 comments on commit 83ce11d

Please sign in to comment.