kmp-ble-mesh/com.atruedev.kmpble.mesh.proxy/ProxyFilter

ProxyFilter

sealed interface ProxyFilter

Proxy filter configuration for the GATT Proxy bearer.

The proxy filter controls which mesh messages the proxy node forwards to the smartphone over the GATT connection. Setting an appropriate filter reduces bandwidth and power consumption.

The filter is sent to the proxy node via Proxy Configuration messages.

Inheritors

Whitelist

Blacklist

AcceptAll

Types

AcceptAll

data object AcceptAll : ProxyFilter

Receive all mesh messages forwarded by the proxy node. Maximum bandwidth usage. Only use for debugging/monitoring.

Blacklist

data class Blacklist(val addresses: Set<MeshAddress>) : ProxyFilter

Receive all messages EXCEPT those addressed to the specified addresses. Use with caution -- broad filters increase GATT bandwidth usage.

Whitelist

data class Whitelist(val addresses: Set<MeshAddress>) : ProxyFilter

Only receive messages addressed to the specified addresses. This is the recommended filter for smartphones -- only receive messages for our unicast address and subscribed group addresses.

Properties

filterTypeCode

open val filterTypeCode: Int

Filter type code for Proxy Configuration messages.