Developer HubProtocols
API Reference

Whitelists (DEPRECATED)

The device permissions in Meshblu, are similar to permissions in *nix based systems. The whitelists are all represented as arrays of UUIDs. The following permissions are supported:

❗️

Missing Property

The absence of a whitelist indicates the property is open. To deny access to all devices, set the property to [], e.g. discoverWhitelist: [ ]

👍

Open Whitelist

To enable access for all devices, set the property to *, e.g. receiveWhitelist: ["*"]

Owner

The owner property of a Meshblu device has special meaning. The UUID listed in the owner property gives that device full access to all whitelists.

🚧

Deprecation Warning

The special meaning of the owner property will be removed in a future version of Meshblu. Whitelists will be the exclusive means of controlling device access.

configureWhitelist

Adding an Updater device's UUID to a device's configureWhitelist will make that device configurable to the Finder. This means that the Updater may update everything about the device, including the device's whitelist. This is the Unix equivalent of root access. 

{
  "uuid":"ad698900-2546-11e3-87fb-c560cb0ca47b",
  "configureWhitelist":[
    "f86e3500-a32d-4914-ab54-d402571f67fc",
    "0c81df27-de55-4e57-a17f-da0d62a99e3d"
  ]
}

discoverWhitelist

Adding a Finder device's UUID to a device's discoverWhitelist will make that device visible to the Finder. This means that the Finder can retrieve the device directly by UUID and that the device will show up when Finder searches for devices.

{
  "uuid":"4c2ef860-2d0d-46ab-b5b3-b24cca0d1f48",
  "discoverWhitelist":[
    "f86e3500-a32d-4914-ab54-d402571f67fc",
    "0c81df27-de55-4e57-a17f-da0d62a99e3d"
  ]
}

receiveWhitelist

Adding a Receiver device's UUID to a device's receiveWhitelist will allow the Receiver to subscribe to that device's broadcast messages.

{
  "uuid":"ad698900-2546-11e3-87fb-c560cb0ca47b",
  "receiveWhitelist":[
    "f86e3500-a32d-4914-ab54-d402571f67fc",
    "0c81df27-de55-4e57-a17f-da0d62a99e3d"
  ]
}

sendWhitelist

Adding a Sender device's UUID to a device's sendWhitelist will allow the Sender to send direct messages to that device.

{
  "uuid":"ad698900-2546-11e3-87fb-c560cb0ca47b",
  "sendWhitelist":[
    "f86e3500-a32d-4914-ab54-d402571f67fc",
    "0c81df27-de55-4e57-a17f-da0d62a99e3d"
  ]
}