Package | Description |
---|---|
com.mmbnetworks.gatewayapi |
Modifier and Type | Method and Description |
---|---|
Collection<ConnectionInfo> |
GatewayClient.getConnectionInfo()
Gets the list of connections that the GatewayClient knows about.
|
Modifier and Type | Method and Description |
---|---|
boolean |
GatewayClient.abortUpgrade(ConnectionInfo connectionInfo)
Cancels a firmware upgrade process that is currently running.
|
GatewayClientBuilder |
GatewayClientBuilder.addConnectionInfo(ConnectionInfo connectionInfo)
Adds a connection info
|
CompletableFuture<NetworkInformation> |
GatewayClient.createNetwork(ConnectionInfo c)
Forms a network on the specified network interface.
|
CompletableFuture<NetworkInformation> |
GatewayClient.createNetwork(ConnectionInfo c,
List<Integer> channels)
Forms a network on the specific network interface, attempting to form on the
best channel from the provided list of channels.
|
boolean |
GatewayClient.deregisterOtaFile(String otaFilePath,
ConnectionInfo connectionInfo)
Deregisters an OTA file on the gateway if an OTA server exists.
|
boolean |
ZigBeePassthroughManager.deregisterReceivedZigBeeFrameListener(ConnectionInfo info,
Consumer<ZigBeeFrame> listener)
De-registers a sent frame listener
|
boolean |
GatewayClient.deregisterReceivedZigBeeMessageListener(ConnectionInfo connectionInfo,
Consumer<ZigBeeFrame> listener)
De-registers a sent frame listener
|
boolean |
ZigBeePassthroughManager.deregisterSendZigBeeFrameListener(ConnectionInfo info,
Consumer<ZigBeeFrame> listener)
De-registers a sent frame listener
|
boolean |
GatewayClient.deregisterSendZigBeeMessageListener(ConnectionInfo connectionInfo,
Consumer<ZigBeeFrame> listener)
De-registers a sent frame listener
|
CompletableFuture<NetworkInformation> |
GatewayClient.dissolveNetwork(ConnectionInfo c)
Dissolves the network on the specified network interface.
|
CompletableFuture<NetworkInformation> |
GatewayClient.getNetworkInfo(ConnectionInfo c)
Returns the network information (status, channel, and id) of the specified network interface.
|
List<String> |
GatewayClient.getRegisteredOtaFiles(ConnectionInfo connectionInfo)
Gets a list of the OTA files registered on the OTA Server if an OTA server exists.
|
boolean |
GatewayClient.registerOtaFile(String otaFilePath,
ConnectionInfo connectionInfo)
Registers an OTA file on the gateway if an OTA server exists.
|
boolean |
ZigBeePassthroughManager.registerReceivedZigBeeFrameListener(ConnectionInfo info,
Consumer<ZigBeeFrame> listener)
Registers a received frame listener
|
boolean |
GatewayClient.registerReceivedZigBeeMessageListener(ConnectionInfo connectionInfo,
Consumer<ZigBeeFrame> listener)
Registers a received frame listener
|
boolean |
ZigBeePassthroughManager.registerSendZigBeeFrameListener(ConnectionInfo info,
Consumer<ZigBeeFrame> listener)
Registers a frame listener to listen in on sent frames
|
boolean |
GatewayClient.registerSendZigBeeMessageListener(ConnectionInfo connectionInfo,
Consumer<ZigBeeFrame> listener)
Registers a frame listener to listen in on sent frames
|
CompletableFuture<NetworkInformation> |
GatewayClient.scanForDevices(ConnectionInfo c,
int duration)
Opens the permit join window on the specified network interface so that devices
who are in pairing mode can join the network.
|
byte |
GatewayClient.sendFrame(ConnectionInfo connectionInfo,
ZigBeeFrame frame)
Sends a raw zigbee frame to the device
|
CompletableFuture<String> |
GatewayClient.sendProtocolMessage(ConnectionInfo connection,
String json)
Sends a protocol-specific message (i.e.
|
byte |
ZigBeePassthroughManager.sendZigBeeFrame(ConnectionInfo connectionInfo,
ZigBeeFrame frame)
Sends a raw zigbee frame to the device
|
CompletableFuture<UpgradeStatus> |
GatewayClient.upgradeFirmware(ConnectionInfo connectionInfo,
File upgradeFile,
ResultConsumer<UpgradeProgress> callback)
Performs a firmware upgrade of the module with the given
connectionInfo and
serialUpgradeFile . |
Modifier and Type | Method and Description |
---|---|
GatewayClientBuilder |
GatewayClientBuilder.addAllConnectionInfo(Collection<ConnectionInfo> connectionInfos)
Adds all the connections.
|
Constructor and Description |
---|
GatewayClient(ConnectionInfo connectionInfo)
Creates a GatewayClient that represents a single network interface.
|
GatewayClient(ConnectionInfo connectionInfo,
DeviceEventHandler handler)
Creates a GatewayClient that represents a single network interface.
|
GatewayClient(ConnectionInfo connectionInfo,
DeviceEventHandler handler,
String configFilePath)
Creates a GatewayClient that represents a single network interface.
|
Constructor and Description |
---|
GatewayClient(Collection<ConnectionInfo> connectionInfoList,
DeviceEventHandler handler)
Creates a GatewayClient that represents an aggregate of many network interfaces, each
represented by its own ConnectionInfo object.
|
GatewayClient(Collection<ConnectionInfo> connectionInfoList,
DeviceEventHandler handler,
String configFilePath)
Creates a GatewayClient that represents an aggregate of many network interfaces, each
represented by its own ConnectionInfo object.
|
ZigBeePassthroughManager(Executor clientEventExecutor,
Collection<ConnectionInfo> localDeviceConnectionInfos,
Function<ConnectionInfo,Optional<com.mmbnetworks.gatewayapi.ZigBeePassthroughDevice>> getPassthroughDevice)
Constructs the ZigBeePassthroughManager
|
ZigBeePassthroughManager(Executor clientEventExecutor,
Collection<ConnectionInfo> localDeviceConnectionInfos,
Function<ConnectionInfo,Optional<com.mmbnetworks.gatewayapi.ZigBeePassthroughDevice>> getPassthroughDevice)
Constructs the ZigBeePassthroughManager
|
Copyright © 2020. All rights reserved.