Skip to content

Commit a5f8059

Browse files
committed
Prepare for public release.
1 parent 92e3fde commit a5f8059

File tree

5 files changed

+31
-10
lines changed

5 files changed

+31
-10
lines changed

.github/workflows/ci.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ on:
77
workflow_dispatch:
88

99
jobs:
10+
hass:
11+
runs-on: "ubuntu-latest"
12+
steps:
13+
- uses: "actions/checkout@v4"
14+
- uses: "home-assistant/actions/hassfest@master"
1015
validate:
1116
runs-on: "ubuntu-latest"
1217
steps:
@@ -15,7 +20,7 @@ jobs:
1520
uses: "hacs/action@main"
1621
with:
1722
category: "integration"
18-
ignore: "brands description topics"
23+
ignore: "brands"
1924
testing:
2025
name: Check
2126
runs-on: ubuntu-latest
@@ -58,6 +63,7 @@ jobs:
5863
name: ci_complete
5964
runs-on: ubuntu-latest
6065
needs:
66+
- hass
6167
- validate
6268
- analyze
6369
- testing

DOCS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Custom modbus documentation.
2+
3+
This is the changed/extended documentation of the
4+
modbus component
5+
6+
There official documentation are found [here](https://github.com/pymodbus-dev/homeassistant_modbus/blob/dev/DOCS.md).

LICENSE.md renamed to LICENSE

File renamed without changes.

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
# Modbus - A Home Assistant custom component.
1+
Modbus - A Home Assistant custom component.
2+
===
23

34
WORK IN PROGRESS, DO NOT USE !!!
45

56

6-
## Install
7+
Install
8+
===
79

810
With HACS:
911

@@ -14,7 +16,8 @@ Otherwise:
1416
copy the [modbus](https://github.com/pymodbus-dev/homeassistant_modbus/blob/dev/custom_components/modbus)
1517
folder into your [custom_components folder](https://developers.home-assistant.io/docs/creating_integration_file_structure/#where-home-assistant-looks-for-integrations).
1618

17-
## Testing
19+
Testing
20+
===
1821

1922
To run the test suite create a virtualenv and install test dependencies::
2023

@@ -27,7 +30,8 @@ the test suite::
2730
$ pytest
2831

2932

30-
## Custom modbus in a nutshell
33+
Custom modbus in a nutshell
34+
===
3135

3236
This is a custom component version of the official Homeassistant modbus,
3337
with active maintenance.
@@ -42,7 +46,9 @@ REMARK: custom modbus is part of the pymodbus development organisation, tying it
4246
firmly to pymodbus.
4347

4448

45-
## Why a custom component ?
49+
Why a custom component ?
50+
===
51+
4652
The reason involves a bit of history.
4753

4854
I maintained the homeassistant modbus component for years and had
@@ -63,15 +69,18 @@ giving modbus users an alternative to the broken official component.
6369
This is NOT the preferred way, nor the best way, but for me the only way !
6470

6571

66-
## Contributing
72+
Contributing
73+
===
74+
6775
We actively monitor both homeassistant issues and the homeassistant user forum for
6876
modbus issues, and then solves (if possible) the problems in this component.
6977

7078
If we have missed your problem/issue, then please feel free to open an issue in
7179
[here](https://github.com/pymodbus-dev/homeassistant_modbus/issues>)
7280

7381

74-
## License Information
82+
License Information
83+
===
7584

7685
Released under a modified [APACHE 2 License](https://github.com/pymodbus-dev/homeassistant_modbus/blob/dev/LICENSE)
7786

custom_components/modbus/manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
"domain": "modbus",
33
"name": "Modbus",
44
"codeowners": ["@janiversen"],
5-
"documentation": "https://www.home-assistant.io/integrations/modbus",
5+
"documentation": "https://github.com/pymodbus-dev/homeassistant_modbus/blob/dev/DOCS.md",
66
"iot_class": "local_polling",
77
"issue_tracker": "https://github.com/pymodbus-dev/homeassistant_modbus/issues",
88
"loggers": ["pymodbus"],
99
"requirements": ["pymodbus==3.11.0"],
10-
"version": "0.1.0"
10+
"version": "0.2.0"
1111
}

0 commit comments

Comments
 (0)