Skip to content

wkronmiller/nad-mqtt-homebridge-plugin

Repository files navigation

NAD MQTT Homebridge Plugin

This Homebridge plugin allows you to control your NAD amplifier via MQTT, integrating it with HomeKit. It supports controlling power, volume, mute, and input source selection.

Features

  • Control your NAD amplifier using HomeKit
  • Power on/off control
  • Volume control (using both TV Speaker and a virtual lightbulb for easier access)
  • Mute control
  • Ready for input source selection (configurable)

Requirements

  • Homebridge v1.8.0 or newer
  • Node.js v18, v20, or v22
  • An MQTT broker
  • A connected NAD amplifier with an MQTT-to-serial bridge

Installation

npm install -g @wkronmiller/homebridge-nad-mqtt-controller

Configuration

Add the platform to your Homebridge config.json:

{
  "platforms": [
    {
      "platform": "NadMqttPlugin",
      "name": "NAD T765",
      "mqtt": {
        "host": "192.168.1.100",
        "port": 1883,
        "username": "your_username",  // Optional
        "password": "your_password",  // Optional
        "topicPrefix": "nad"
      },
      "inputs": [
        {
          "name": "TV",
          "sourceNumber": 1
        },
        {
          "name": "PC",
          "sourceNumber": 2
        }
        // Add more inputs as needed
      ]
    }
  ]
}

MQTT Topic Structure

The plugin expects the following MQTT topic structure:

  • Power control: nad/main/power/set and nad/main/power/get
  • Volume control: nad/main/volume/set and nad/main/volume/get
  • Mute control: nad/main/mute/set and nad/main/mute/get
  • Source selection: nad/main/source/set and nad/main/source/get

Volume Scaling

The plugin scales volume between the NAD's range (-80dB to 10dB) to HomeKit's 0-100% range. This makes controlling the volume more intuitive through the Home app.

Setup Development Environment

To develop Homebridge plugins you must have Node.js 18 or later installed, and a modern code editor such as VS Code. This plugin template uses TypeScript to make development easier and comes with pre-configured settings for VS Code and ESLint. If you are using VS Code install these extensions:

Install Development Dependencies

Using a terminal, navigate to the project folder and run this command to install the development dependencies:

npm install

Build Plugin

TypeScript needs to be compiled into JavaScript before it can run. The following command will compile the contents of your src directory and put the resulting code into the dist folder.

npm run build

Link To Homebridge

Run this command so your global installation of Homebridge can discover the plugin in your development environment:

npm link

You can now start Homebridge, use the -D flag, so you can see debug log messages in your plugin:

homebridge -D

Watch For Changes and Build Automatically

If you want to have your code compile automatically as you make changes, and restart Homebridge automatically between changes, you first need to add your plugin as a platform in ./test/hbConfig/config.json:

{
...
    "platforms": [
        {
            "name": "Config",
            "port": 8581,
            "platform": "config"
        },
        {
            "name": "NAD MQTT Controller",
            "platform": "NadMqttPlugin",
            "mqtt": {
                "host": "localhost",
                "port": 1883,
                "topicPrefix": "nad"
            }
        }
    ]
}

and then you can run:

npm run watch

This will launch an instance of Homebridge in debug mode which will restart every time you make a change to the source code. It will load the config stored in the default location under ~/.homebridge. You may need to stop other running instances of Homebridge while using this command to prevent conflicts. You can adjust the Homebridge startup command in the nodemon.json file.

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published