56 lines
2.4 KiB
Markdown
56 lines
2.4 KiB
Markdown
# MqttCreator
|
|
|
|
This project is a simple and incomplete generator to create a Homeassinstant compatible MQTT Autodiscovery Entity
|
|
|
|
## Limited Coverage
|
|
By now only the these entities (binary_sensor, light, sensor, switch) are supported by the generator, because they are the most commmonly used entities for my own needs
|
|
|
|
## Usage
|
|
The UI is seperated into two parts, the global generator with settings and upper Topic and the entity itselt
|
|
|
|
### Generator:
|
|
Automated Topic Settings:
|
|
- all: the topics will be generated automatically from the other supplied inputs, all changes will be wiped
|
|
- only changes: user inputs will be synced accross all topics (only works if the general structure stays the same and changes are not to large at once)
|
|
- none: everything is done manually
|
|
|
|
### Entity:
|
|
After choosing an entity type, change and input the corresponding values as you like and if automated topics is actived the topics will be populated automatically
|
|
|
|
Once done, you can press the DiscoveryString button.
|
|
|
|
### Discovery String:
|
|
First you see the discovery string formatted, there you can check for any errors in the configuration
|
|
|
|
Below there will be a discovery string with escaped perentecies to input into print statements or similar
|
|
|
|
The last field Discovery Topic is the automatically generated Discovery Topic for default Homeassistant MQTT Autodiscovery
|
|
|
|
|
|
|
|
<!-- This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.4.
|
|
|
|
## Development server
|
|
|
|
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
|
|
|
|
## Code scaffolding
|
|
|
|
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
|
|
|
|
## Build
|
|
|
|
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
|
|
|
|
## Running unit tests
|
|
|
|
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
|
|
|
|
## Running end-to-end tests
|
|
|
|
Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
|
|
|
|
## Further help
|
|
|
|
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page. -->
|