Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bj00rn committed Jul 6, 2023
1 parent 963b0d6 commit 6f99f8c
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 25 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@
[![Project Maintenance][maintenance-shield]][user_profile]
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]


*Component to integrate with [Saleryd HRV Systems](https://saleryd.se/produkt-kategori/ftx-ventilation/)*

**Disclaimer**
## Disclaimer

This integration has been developed for LOKE1 HRV system. *Use at own risk*. I am in no way affiliated with Saleryd. All trademarks belong to their respective owners.

**Sensors**
## Sensors

Name | Description | Unit |
-- | -- | --
Expand All @@ -32,7 +31,7 @@ Name | Description | Unit |
`temperature_mode` | current temperature mode setting | `str`
`ventilation_mode` | current ventilation mode setting | `str`

**Switches**
## Switches

Switch | Description
-- | --
Expand All @@ -42,54 +41,55 @@ Switch | Description
`cooling_mode` | Turn Cooling vent mode on/off
`fireplace_mode` | Turn Fireplace vent mode on/off


**Services**
## Services

Name | Description | Fields
-- | -- | --
`set_fireplace_mode` | Set fireplace mode | value: `integer` (0=On, 1=off)
`set_ventilation_mode` | Set ventilation mode | value: `integer` (0=Home,1=Away,2=High)
`set_temperature_mode` | Set temperature mode | value: `integer` (0=Normal,1=Economy,2=Comfort)
`set_cooling_mode` | Set cooling mode | value: `integer` (0=On, 1=off)

## Confirmed supported devices
`set_fireplace_mode` | Set fireplace mode | value: `integer` (0=On, 1=Off)
`set_ventilation_mode` | Set ventilation mode | value: `integer` (0=Home,1=Away,2=Boost)
`set_temperature_mode` | Set temperature mode | value: `integer` (0=Normal,1=Economy,2=Cool)
`set_cooling_mode` | Set cooling mode | value: `integer` (0=On, 1=Off)

Model | Control system versions
-- | --
[LOKE01/LOKE BASIC/LS-01](https://saleryd.se/produkt/varmeatervinningsaggregat-loke/) | 4.1.1
## Supported devices

Model | Confirmed supported control system versions | Unsupported control system versions
-- | -- | --
[LOKE01/LOKE BASIC/LS-01](https://saleryd.se/produkt/varmeatervinningsaggregat-loke/) | 4.1.5 | <4.1.5

## Prequisites

1. Connect HRV to local network . See instructions in user manual
2. Take note of the assigned IP adress of the HRV system

## Installation

1. In the HA UI go to "HACS" and add this repository
2. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Saleryd HRV".
3. Click install


## Configuration

### configuration.yaml

Configuration in congfiguration.yaml is not supported


### Configuration in the UI

Setting | Description
-- | --
IP | IP adress of the HRV system on the local network
PORT | Port number of websocket, default 3001

## Troubleshooting

### Can't connect to HRV system

## Troubleshooting ##
### Can't connect to HRV system ###
* Confirm system is connected and UI is reachable on the local network. Follow steps in the manual.
* Confirm websocket port by connecting to the UI using a browser and take note of websocket port using debug console in browser. 3001 is probably default
* The system HRV system can only handle a few connected clients. Shut down any additional clients/browsers and try again

## Related projects

## Related projects ##
https://github.com/bj00rn/pysaleryd

[saleryd_ftx]: https://github.com/bj00rn/ha-saleryd-ftx
Expand Down
2 changes: 1 addition & 1 deletion custom_components/saleryd_hrv/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"documentation": "https://github.com/bj00rn/ha-saleryd-ftx",
"iot_class": "local_push",
"issue_tracker": "https://github.com/bj00rn/ha-saleryd-ftx",
"version": "2.0.11",
"version": "2.0.12",
"config_flow": true,
"codeowners": [
"@bj00rn"
Expand Down
8 changes: 4 additions & 4 deletions custom_components/saleryd_hrv/services.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ set_fireplace_mode:
description: Set fireplace mode on or off
fields:
value:
description: desired value (0=Off,1=On)
description: desired mode (0=Off,1=On)
example: "1"
required: true
selector:
Expand All @@ -14,7 +14,7 @@ set_cooling_mode:
description: Set cooling mode on or off
fields:
value:
description: desired value (0=Off,1=On)
description: desired mode (0=Off,1=On)
example: "1"
required: true
selector:
Expand All @@ -26,7 +26,7 @@ set_ventilation_mode:
description: Set ventilation mode
fields:
value:
description: desired value (0=Home,1=Away,2=High)
description: desired mode (0=Home,1=Away,2=Boost)
example: "1"
required: true
selector:
Expand All @@ -38,7 +38,7 @@ set_temperature_mode:
description: Set temperature mode
fields:
value:
description: desired value (0=Cooling,1=Economy,2=Comfort)
description: desired mode (0=Normal,1=Economy,2=Cool)
example: "1"
required: true
selector:
Expand Down

0 comments on commit 6f99f8c

Please sign in to comment.