homebridge-meraki-control

1.1.2 • Public • Published

Homebridge Meraki Control

verified-by-homebridge npm npm npm GitHub pull requests GitHub issues

Homebridge plugin for Meraki Dashboard and Devices control using RESTFull API.

Package Requirements

Package Installation Role Required
Homebridge Homebridge Wiki HomeKit Bridge Required
Config UI X Config UI X Wiki Homebridge Web User Interface Recommended
Meraki Control Plug-In Wiki Homebridge Plug-In Required

About The Plugin

  • Dashboard:
    • Expose Clients filtered by Mac Address.
    • Apply policy Normal, Whitelisted, Group Policy / Blocked for clients.
    • Enable/Disable prefix C. for Clients name displayed in HomeKit.app.
    • Expose Contact Sensors in HomeKit app for exposed Clients.
  • Access Points:
    • Switch ON/OFF SSIDs in the organisation.
    • Enable/Disable prefix W. for SSIDs name displayed in HomeKit.app.
    • Hide Unconfigured SSIDs networks, if the name contain word Unconfigured.
    • Hide SSIDs filtered by network Name.
    • Expose Contact Sensors in HomeKit app for exposed SSIDs.
  • Switches:
    • Switch ON/OFF ports.
    • Switch ON/OFF POE+ ports.
    • Enable/Disable prefix Port Number for Ports name displayed in HomeKit.app.
    • Hide Uplink ports, if the port name contain word Uplink.
    • Hide Ports filtered by port Name.
    • Expose Contact Sensors in HomeKit app for exposed Ports.
  • Siri can be used to switch ON/OFF SSIDs, Policy, Ports.
  • Home automations and shortcuts can be used for all functions.

Configuration

  • Run this plugin as a Child Bridge (Highly Recommended), this prevent crash Homebridge if plugin crashes.
  • Install and use Homebridge Config UI X to configure this plugin.
  • The sample-config.json can be edited and used as an alternative.
  • Be sure to always make a backup copy of your config.json file before making any changes to it.

Key Description
name Here set the accessory Name to be displayed in Homebridge/HomeKit.
host Here set the API Path like https://n123.meraki.com, do not use https://api.meraki.com.
apiKey Here set the X-Cisco-Meraki-API-Key.
organizationId Here set the Organization Id.
networkId Here set the Network Id.
dashboardClientsControl This option Enable/Disable dashboard clients control.
enablePrefixForClientName This option enable prefix C. for Client name displayed in HomeKit app.
enableSonsorClients This option expose Contact Sensor in HomeKit app for all exposed Clients.
dashboardClientsPolicy.name Here set the Name to be displayed in the the Homebridge/HomeKit for this Client.
dashboardClientsPolicy.mac Here set the Client Mac Address which You want expose to the Homebridge/HomeKit.
dashboardClientsPolicy.type Here choice the policy Type to be appiled for this Client.
dashboardClientsPolicy.mode Here Activate/Deactivate this Client control.
accessPointsControl This option Enable/Disable control of Access Points.
hideUnconfiguredSsids If enabled, all Unconfigured SSIDs will be hidden and not exposed to the Homebridge/HomeKit.
enablePrefixForSsidsName This option enable prefix W. for SSIDs name displayed in HomeKit app.
hideSsids.name Here set SSID Name which You want hide and not expose to the Homebridge/HomeKit.
hideSsids.mode Here Activate/Deactivate this SSID control.
enableSonsorSsids This option expose Contact Sensor in HomeKit app for all exposed SSIDs.
switchesControl This option Enable/Disable control of Switches.
switches.name Here set the Name for this Switch.
switches.serialNumber Here set the Serial Number for this Switch.
switches.hideUplinkPorts If enabled, all Uplink ports will be hidden and not exposed to the Homebridge/HomeKit.
switches.enablePrefixForPortName This option enable prefix Port Number for Port name displayed in HomeKit app.
switches.enablePoePortsControl This option enable POE control for controled ports.
switches.enableSensorPorts This option enable POE control for controled ports.
switches.mode Here Activate/Deactivate this Swich control.
switches.hidePorts Array of hidden Ports.
switches.hidePorts.name Here set Port Name which You want hide and not expose to the Homebridge/HomeKit.
switches.hidePorts.mode Here Activate/Deactivate this Port control.
enableDebugMode This enable deep log in homebridge console.
disableLogInfo This disable display log values and states on every it change.
disableLogDeviceInfo This disable display log device info on plugin start.
refreshInterval Here set the data refresh time in seconds.

Package Sidebar

Install

npm i homebridge-meraki-control

Weekly Downloads

24

Version

1.1.2

License

MIT

Unpacked Size

81 kB

Total Files

13

Last publish

Collaborators

  • grzegorz914