homebridge-mazda v1.0.9

Mazda Connect for Homebridge

View vehicle status, unlock doors, remote start and more with Mazda Connect for Homebridge

Thank you to bdr99 for making this possible via the node-mymazda library.

Supported Featured

• Remote start and stop engine
• View remaining vehicle mileage as a percentage
• View status of vehicle doors, e.g. locked or unlocked

Coming Soon

• Climate control
• Electric vehicle support
• Tire pressure

Configuration

Only the username, password and region values are required. Default values are provided for autoRefresh and vehicles (overrides) are strictly optional. See below for further configuration details.

{
    "platform": "HomebridgeMazda",
    // Mazda Connect client configuration
    "username": "<mazda connect email>",
    "password": "<mazda connect password>",
    "region": "<mazda connect region, see below>",
    // Vehicle status auto refresh configuration
    "autoRefresh": {
        "enabled": true,
        "interval": 30
    },
    // vehicle overrides, see below
    "vehicles": [
        {
            "vin": "<vin to match>", // the overrides are matched based on the vehicle VIN
            "nickname": "Mazda3", // override default vehicle name, e.g. Mazda3 Doors instead of 2022 Mazda3 Sedan Doors 
            "disabled": false // true will prevent the vehicle from being added to HomeKit
        }
    ]
}

Mazda Connect Configuration

The username and password are the email and password used to login to the Mazda Connect app.

The region represents the Mazda Connect server region responsible for handling API requests. It is one of the following:

Auto Refresh

Auto refresh is enabled by default and will automatically refresh the vehicle status at the given interval in minutes, defaulting to 30. Disable it by toggling enabled to false.

Vehicle Overrides

Vehicle overrides are strictly optional and only necessary in order to change attributes of a specific vehicle.

Overrides are matched to the correct vehicle using the vin. The VIN should be in uppercase format and can easily be retrieved from the Homebridge logs.

The nickname field provides an override for the default vehicle name made up of the year, make and model, e.g. Mazda3 vs. 2022 Mazda3 Sedan. The name (or nickname) is used to name the accessories in HomeKit, e.g. Mazda3 Doors or Mazda3 Engine.

The disabled fields allows for a specific vehicle to be completely disabled and not appear in Homebridge/HomeKit.

Developing

Using a separate Home in Home Kit is recommended for testing.

Setup Development Environment

Using Node.js 14.x or greater, install the plugin's dependencies.

npm install

Building

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 install 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

# or 

npm run watch