homebridge-automower-platform

2.2.0 • Public • Published

Homebridge Automower Platform

verified-by-homebridge

build Quality Gate Status Security Rating Reliability Rating Vulnerabilities

A plugin for controlling Husqvarna Automower and Gardena Smart robotic lawn mowers as Apple HomeKit accessories using the Husqvarna Group cloud services.

Be advised, because this plug-in uses cloud services, service disruptions or outages are possible as it relies solely on the aforementioned cloud services to manage the communication with your mowers(s).

Installation

For help installing and configuring the plugin, please see the documentation found at: https://jeff-winn.github.io/homebridge-automower-platform

Hardware Requirements

The following hardware requirements are necessary for the proper operation of the plug-in. If you are unsure whether your mower is supported by the plug-in, you can find the compatibility matrix HERE.

  • The Automower must have an Automower Connect module installed, Bluetooth only models will require an upgrade. For more information, please contact your local Husqvarna Automower dealer.
  • The Sileno must be a Smart series mower which you can control remotely via an app while not near the device, Bluetooth only models are not supported.

Known Issues

  • Starting with iOS 16, Apple has changed their naming scheme within HomeKit such that all services for an accessory use the accessory name. If all the switches and sensors are named after your mower, and you are using 1.4.0 or later of the plug-in, removing the mower using the instructions found HERE should correct the issue.

Supported Capabilities

Be advised, the capabilities mentioned below vary between product lines by Husqvarna. Depending on the type of robotic mower you are using, different capabilities will be provided by the plug-in.

  • A switch to control whether each mower (based on configuration - see documentation):
    • should mow the property.
    • or has the on-board schedule enabled or disabled.
  • A pause switch to control whether each mower:
    • should pause while mowing on the property, and resume once the switch is turned off.
  • A motion sensor to indicate whether each mower:
    • is moving about the property.
    • has been tampered with (requires the Husqvarna app to troubleshoot) and needs assistance. **
    • has encountered a fault (requires the Husqvarna app to troubleshoot) and needs assistance. **
  • A contact sensor to indicate when each mower:
    • is going to the charge station, by indicating open contact state.
    • has arrived home, or resumed operation, by indicating closed contact state.
  • A contact sensor to indicate when each mower:
    • is leaving the charge station, by indicating open contact state.
    • has left home, or returned home, by indicating closed contact state.
  • A custom characteristic to modify the cutting height of the mower. **

** These features are not directly supported within the Apple HomeKit app and will require a 3rd party application (such as Controller for HomeKit) to use for any automations.

Additional Capabilities

  • The sensors may now be turned on or off based on your personal needs within the configuration settings.
  • Streams events from Husqvarna rather than polling for changes. This allows you to run automations without having to worry about the timing of when a change is noticed, it should be within a few seconds.
  • Does not cause logout of Husqvarna mobile application.
  • Multiple languages may be supported in logs (need help with translations).

Configuration Settings

The following describes the configuration settings available within the plugin. If you are using Homebridge, manually configuring the plugin is highly discouraged. However, the section is described as follows:

{
  "platform": "Homebridge Automower Platform",
  "name": "Homebridge Automower Platform",
  "device_type": "automower",
  "sensor_mode": "all",
  "lang": "en",
  "authentication_mode": "client_credentials",
  "appKey": "<<REDACTED>>",
  "application_secret": "<<REDACTED>>"
}
  • platform: This MUST be "Homebridge Automower Platform"
  • name: This will be the name of the plugin that shows up in the logs
  • device_type: This determines which kind of mower is being configured. The following device types are supported:
    • automower: For use with Husqvarna Automower robotic lawn mowers
    • gardena: For use with Gardena Smart robotic lawn mowers
  • sensor_mode: This determines which sensors will be registered for each mower that is located. The following sensor modes are supported:
    • all: All sensors available
    • motion_only: Only motion sensors will be registered
    • contact_only: Only contact sensors will be registered
    • none: No sensors
  • lang: This will be the language used during logging. The following languages are supported:
    • en: English (US)
  • authentication_mode: The type of authentication modes available to login to Husqvarna Group cloud services. The following authentication modes are supported:
    • client_credentials: Uses an application key and secret defined by the Husqvarna Group cloud services to login. This will require additional setup on their website
  • appKey: This is the application key as registered on the Husqvarna Group cloud services
  • application_secret: This is the application secret as registered on the Husqvarna Group cloud services

Other Settings

These settings will likely never be required unless explicitly asked to do so by someone helping maintain the plugin. These will not able to be configured in the plugin settings by the user interface, and manually editing the config section will be needed. These settings may change at any time, without warning.

  • logger_type: Used to change how the plugin logs information to the output stream. This is here to aid with debugging issues that may occur in the plugin.
    • default: This is the default mode, nothing to see here
    • imitation: This mode allows debug logging based on an environment configuration setting
    • force_debug: This is likely the easiest approach to debugging just this plugin, without having to debug all plugins on a server

Disclaimer

This plug-in is in no way affiliated with Husqvarna, the Husqvarna Group, or any of its subsidiaries or partners. Any trademarks used here-in are property of Husqvarna and/or the Husqvarna Group.

Package Sidebar

Install

npm i homebridge-automower-platform

Weekly Downloads

39

Version

2.2.0

License

MIT

Unpacked Size

242 kB

Total Files

81

Last publish

Collaborators

  • jeff-winn