NodeJS MQTT Client built to use with Home Assisant to add automation to your computer.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

TODO

Built With

• TypeScript (NodeJS)
• MQTT

Getting Started

Download the latest release.

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation (for contributers)

Prerequisites

This is an example of how to list things you need to use the contribute and how to install them.

• mqtt broker (mosquitto)
• AudioCmdlets (OPTIONAL)
  • Required to use any of the audioCmdlets build in commands
    • Change Sound Devices
    • Control Volume
    • Change mute state

1. Clone the repo

   git clone https://github.com/ericellb/homeassisant-mqtt-client
   

2. Install deps

   yarn install OR npm install
   

3. Create your .env file

   // EXAMPLE ENV FILE
   MQTT_URL = 'mqtt://192.168.0.3:1883';
   MQTT_USERNAME = 'your_username';
   MQTT_PASSWORD = 'your_password';

Installation (for users)

1. Download the release
2. Add the homeassistant-mqtt-client.exe to windows startup folder
3. Add the included VBS script that will autorun the exe
4. Run the cli-integration-adder to add new custom integrations
5. Start the homeassistant-mqtt-client (will auto start on next startup)
6. Profit!

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contributers

Eric Ellbogen - [email protected]

Project Link: https://github.com/ericellb/homeassisant-mqtt-client