BEFORE ALL ELSE... (Guidelines_for_Troubleshooting)

[mkormendy]

Before reporting an issue, there are a number of reasons why this Homebridge plugin may not be working. Here's some steps to follow to work towards a fix:

1. Make sure you're Homebridge config.json file is properly formatted (see the default sample file here) and the settings for this plugin are correct for your Alarm.com account.
2. Refresh the accessories cache by starting Homebridge with the -R flag:
   homebridge -R
   If your homebridge is set to start on boot, you may need to disable that first and start it manually on the command line to refresh the cache and see if the problems continue while in this setup before restoring the start on boot setup.
3. Try deleting the cachedAccessories file:
   a. FIRST, stop Homebridge (this is important);
   b. locate and delete the ~/.homebridge/accessories/cachedAccessories file;
   c. start up Homebridge again and test for success.
4. Make sure that all parts of the plugin have been updated to their latest or expected versions, use the following command:
   sudo npm list node-alarm-dot-com

If at this point things are not working, please submit a ticket using the Bug Report template.

Once you have submitted the ticket, you can also visit the Slack channel Discord channel (moved from Slack to Discord) to see if others are working on the issue already.

---

As a last resort (not recommended due to the destructive nature), the following steps can help reset your entire Homekit/Homebridge integration:

NOTE: this will remove all Homebridge based accessories, their locations in the rooms of Home.app, their automations, scenes, configurations and any related data stored in Homekit. BE VERY CAREFUL!

1. Remove Homebridge from HomeKit in the Home.app on your "iDevice".
2. Stop Homebridge.
3. Delete the accessories and persist folders in the ~/.homebridge/ folder.
4. Edit config.json settings:
   a. changing the homebridge user name (just change one character or number in that hex style sequence, without removing any of the colons);
   b.remove any unwanted plugins from the accessories and platforms sections.
5. Start Homebridge from the command line.
6. Add Homebridge back to HomeKit.

If the issue persists, please submit a ticket using the Bug Report template.