Skip navigation links
A B C D E F G H I L M N O P R S T U V W Z 

A

abortOtaUpgrade() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Abort an ongoing OTA upgrade.
abortOtaUpgrade() - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Abort an ongoing OTA upgrade.
abortUpgrade(ConnectionInfo) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Cancels a firmware upgrade process that is currently running.
accept(DeviceProperty, DeviceModel.DevicePropertyEventEnum) - Method in class com.mmbnetworks.gatewayapi.entity.Device
 
accept(String) - Method in class com.mmbnetworks.gatewayapi.entity.Device
 
accept(Device, Property) - Method in class com.mmbnetworks.gatewayapi.sample.iaszone.IasPropertyHandler
 
accept(Device, String) - Method in class com.mmbnetworks.gatewayapi.sample.iaszone.IasProtocolPassthroughHandler
 
AccessControl - Enum in com.mmbnetworks.gatewayapi.entity
Determines the access control of a Property
addAllConnectionInfo(Collection<ConnectionInfo>) - Method in class com.mmbnetworks.gatewayapi.GatewayClientBuilder
Adds all the connections.
addConnectionInfo(ConnectionInfo) - Method in class com.mmbnetworks.gatewayapi.GatewayClientBuilder
Adds a connection info
addDeviceEventHandler(DeviceEventHandler) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Allows a class to register itself to receive DeviceEvent.
addDeviceEventHandler(DeviceEventHandler) - Method in class com.mmbnetworks.gatewayapi.GatewayClientBuilder
Add a device event handler that is called when a device is added, or removed
addGroup(int, String) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Adds a group to this Device's group table.
addGroupIfIdentifying(int, String) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Adds a group to this Device's group table if it is identifying itself.
addPropertyUpdateHandler(BiConsumer<Device, Property>) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Adds a Property update handler.
addProtocolHandler(BiConsumer<Device, String>) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Adds a ProtocolHandler to handle protocol messages from the Device.
addToGroup(int) - Method in class com.mmbnetworks.gatewayapi.entity.Device
 
adjustOccupiedSetpoint(Thermostat.SetpointModeEnum, double) - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Adjusts the heating or cooling setpoint up or down by a specified amount.
assignDevice(Device) - Method in interface com.mmbnetworks.gatewayapi.Group
Assign a device to this Group.
assignDeviceIfIdentifying(Device) - Method in interface com.mmbnetworks.gatewayapi.Group
Assign a device to this Group only if it is identifying itself.

B

bindDevice(String, String) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Creates a binding between this device (the source) and a destination device, on the specified Property.
build() - Method in class com.mmbnetworks.gatewayapi.GatewayClientBuilder
Constructs a new GatewayClient object upon invocation

C

callFunction(String) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Calls a function on the device model with the supplied parameters.
changeFanMode(FanControl.FanModeEnum) - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Changes the FanControl.FanModeEnum of the Thermostat.
changeName(String) - Method in interface com.mmbnetworks.gatewayapi.Group
Change the current group name to newName
changeSystemMode(Thermostat.SystemModeEnum) - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Changes the Thermostat.SystemModeEnum of the Thermostat.
channel - Variable in class com.mmbnetworks.gatewayapi.NetworkInformation
 
code() - Method in enum com.mmbnetworks.gatewayapi.exception.ExceptionCode
 
com.mmbnetworks.gatewayapi - package com.mmbnetworks.gatewayapi
 
com.mmbnetworks.gatewayapi.entity - package com.mmbnetworks.gatewayapi.entity
 
com.mmbnetworks.gatewayapi.event - package com.mmbnetworks.gatewayapi.event
 
com.mmbnetworks.gatewayapi.event.device - package com.mmbnetworks.gatewayapi.event.device
 
com.mmbnetworks.gatewayapi.event.group - package com.mmbnetworks.gatewayapi.event.group
 
com.mmbnetworks.gatewayapi.exception - package com.mmbnetworks.gatewayapi.exception
 
com.mmbnetworks.gatewayapi.sample - package com.mmbnetworks.gatewayapi.sample
 
com.mmbnetworks.gatewayapi.sample.iaszone - package com.mmbnetworks.gatewayapi.sample.iaszone
 
completionException(ExceptionCode, String) - Static method in class com.mmbnetworks.gatewayapi.exception.ExceptionUtils
 
configureReporting(String, List<Parameter>) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Configures reporting a specified Property on this device.
ConnectionInfo - Class in com.mmbnetworks.gatewayapi
Represents a network interface that the GatewayClient can connect to.
ConnectionInfo(ConnectionInfo.ConnectionType, String) - Constructor for class com.mmbnetworks.gatewayapi.ConnectionInfo
Creates an object to represent a network interface.
ConnectionInfo.ConnectionType - Enum in com.mmbnetworks.gatewayapi
Lists all support connection types.
create() - Method in class com.mmbnetworks.gatewayapi.RateLimitPolicy.RateLimitPolicyBuilder
Creates the rate limit policy object
create() - Method in class com.mmbnetworks.gatewayapi.UpgradePolicy.UpgradePolicyBuilder
Creates the upgrade policy object
createGroup(int, String) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Create a Group object with the associated groupID and groupName.
createGroup(int, String) - Method in interface com.mmbnetworks.gatewayapi.GroupManager
Create a Group object with the associated groupID and groupName.
createNetwork(ConnectionInfo) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Forms a network on the specified network interface.
createNetwork(ConnectionInfo, List<Integer>) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Forms a network on the specific network interface, attempting to form on the best channel from the provided list of channels.
createResultConsumer(Consumer<V>, Consumer<Throwable>) - Static method in interface com.mmbnetworks.gatewayapi.event.ResultConsumer
Convenience Method that generates a ResultConsumer.

D

deregisterAllGroupEventHandler() - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Deregister all registered groupEventHandler.
deregisterAllGroupEventHandler() - Method in interface com.mmbnetworks.gatewayapi.GroupManager
Deregister all groupEventHandler that have been registered previously.
deregisterGroupEventHandler(GroupEventHandler) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Removes a previously registered groupEventHandler.
deregisterGroupEventHandler(GroupEventHandler) - Method in interface com.mmbnetworks.gatewayapi.GroupManager
Deregister the groupEventHandler so that it will no longer receive GroupEvent.
deregisterOtaFile(String, ConnectionInfo) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Deregisters an OTA file on the gateway if an OTA server exists.
deregisterOtaProgressHandler(Consumer<UpgradeProgress>) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Deregisters the OTA upgrade progress handler, which stops displaying the progress of the upgrade.
deregisterReceivedZigBeeFrameListener(ConnectionInfo, Consumer<ZigBeeFrame>) - Method in class com.mmbnetworks.gatewayapi.ZigBeePassthroughManager
De-registers a sent frame listener
deregisterReceivedZigBeeMessageListener(ConnectionInfo, Consumer<ZigBeeFrame>) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
De-registers a sent frame listener
deregisterSendZigBeeFrameListener(ConnectionInfo, Consumer<ZigBeeFrame>) - Method in class com.mmbnetworks.gatewayapi.ZigBeePassthroughManager
De-registers a sent frame listener
deregisterSendZigBeeMessageListener(ConnectionInfo, Consumer<ZigBeeFrame>) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
De-registers a sent frame listener
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.mmbnetworks.gatewayapi.entity.FunctionObjectDeserializer
 
Device - Class in com.mmbnetworks.gatewayapi.entity
Represents a device on the network.
DeviceConnectionType - Enum in com.mmbnetworks.gatewayapi.entity
Represents the way a module is connected to the GatewayClient.
DeviceEvent - Class in com.mmbnetworks.gatewayapi.event.device
An event associated with a Device.
DeviceEvent(DeviceEventStatus, Device) - Constructor for class com.mmbnetworks.gatewayapi.event.device.DeviceEvent
Creates a DeviceEvent object.
DeviceEventHandler - Interface in com.mmbnetworks.gatewayapi.event.device
The handler interface for receiving device events.
DeviceEventStatus - Enum in com.mmbnetworks.gatewayapi.event.device
Enumerates the device events that can propagate from the GatewayClient.
DeviceType - Class in com.mmbnetworks.gatewayapi.entity
Represents a device type at a logical level.
DeviceType(String, String) - Constructor for class com.mmbnetworks.gatewayapi.entity.DeviceType
Creates a DeviceType
discoverAllProperties() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Gets all Property objects associated with this device type.
dissolveNetwork(ConnectionInfo) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Dissolves the network on the specified network interface.

E

enableDefaultReporting() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Configures the device to report changes to its properties to the GatewayClient to which it is connected.
enableDefaultReporting() - Method in class com.mmbnetworks.gatewayapi.entity.LightDevice
Configures the device to report changes to its properties to the GatewayClient to which it is connected.
enableDefaultReporting() - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Configures the device to report changes to its properties to the GatewayClient to which it is connected.
enableDefaultReporting() - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
 
equals(Object) - Method in class com.mmbnetworks.gatewayapi.ConnectionInfo
 
equals(Object) - Method in class com.mmbnetworks.gatewayapi.entity.DeviceType
 
equals(Object) - Method in class com.mmbnetworks.gatewayapi.entity.Property
 
exceptionalFuture(ExceptionCode, String) - Static method in class com.mmbnetworks.gatewayapi.exception.ExceptionUtils
 
ExceptionCode - Enum in com.mmbnetworks.gatewayapi.exception
 
ExceptionUtils - Class in com.mmbnetworks.gatewayapi.exception
 
ExceptionUtils() - Constructor for class com.mmbnetworks.gatewayapi.exception.ExceptionUtils
 

F

FIXED_DELAY - Static variable in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
FunctionObject - Class in com.mmbnetworks.gatewayapi.entity
This class is a convenience utility class that handles creating the json format to call the function objects
FunctionObject(String) - Constructor for class com.mmbnetworks.gatewayapi.entity.FunctionObject
Constructs FunctionObject
FunctionObject(String, Map<String, String>) - Constructor for class com.mmbnetworks.gatewayapi.entity.FunctionObject
Constructs a FunctionObject
FunctionObject(String, Parameter...) - Constructor for class com.mmbnetworks.gatewayapi.entity.FunctionObject
Constructs a FunctionObject
FunctionObjectDeserializer - Class in com.mmbnetworks.gatewayapi.entity
 
FunctionObjectDeserializer() - Constructor for class com.mmbnetworks.gatewayapi.entity.FunctionObjectDeserializer
 

G

GatewayClient - Class in com.mmbnetworks.gatewayapi
The GatewayClient represents an aggregation of one or more network interfaces.
GatewayClient(ConnectionInfo) - Constructor for class com.mmbnetworks.gatewayapi.GatewayClient
Creates a GatewayClient that represents a single network interface.
GatewayClient(ConnectionInfo, DeviceEventHandler) - Constructor for class com.mmbnetworks.gatewayapi.GatewayClient
Creates a GatewayClient that represents a single network interface.
GatewayClient(ConnectionInfo, DeviceEventHandler, String) - Constructor for class com.mmbnetworks.gatewayapi.GatewayClient
Creates a GatewayClient that represents a single network interface.
GatewayClient(Collection<ConnectionInfo>, DeviceEventHandler) - Constructor for class com.mmbnetworks.gatewayapi.GatewayClient
Creates a GatewayClient that represents an aggregate of many network interfaces, each represented by its own ConnectionInfo object.
GatewayClient(Collection<ConnectionInfo>, DeviceEventHandler, String) - Constructor for class com.mmbnetworks.gatewayapi.GatewayClient
Creates a GatewayClient that represents an aggregate of many network interfaces, each represented by its own ConnectionInfo object.
GatewayClientBuilder - Class in com.mmbnetworks.gatewayapi
Facilitates building a GatewayClient
GatewayClientBuilder() - Constructor for class com.mmbnetworks.gatewayapi.GatewayClientBuilder
Constructs a GatewayClientBuilder object
GatewayConnectionException - Exception in com.mmbnetworks.gatewayapi.exception
This exception class is used to report errors and unexpected processing conditions related to connecting to network interfaces.
GatewayConnectionException(String) - Constructor for exception com.mmbnetworks.gatewayapi.exception.GatewayConnectionException
Construct an exception with the associated message.
GatewayConnectionException(Throwable) - Constructor for exception com.mmbnetworks.gatewayapi.exception.GatewayConnectionException
 
getAccessControl() - Method in class com.mmbnetworks.gatewayapi.entity.Property
Returns Access Control of this property
getAllGroups() - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Get all Group objects.
getAllGroups() - Method in interface com.mmbnetworks.gatewayapi.GroupManager
Get all Group objects in the network.
getApiVersion() - Static method in class com.mmbnetworks.gatewayapi.GatewayClient
Get the API version number.
getCachedProperties() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Gets all currently known Property objects associated with this device type.
getCachedProperty(String) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Gets the Property with the associated propertyName.
getCachedProperty() - Method in class com.mmbnetworks.gatewayapi.PropertyCommandData
Get the last known value of the Property.
getCachedProtocolProperties() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Gets all currently known Property objects associated with this device type.
getCategory() - Method in class com.mmbnetworks.gatewayapi.entity.DeviceType
Gets the device category.
getConnectedGatewayId() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Get the String identifier of the Gateway that this Device is connected to.
getConnectionInfo() - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Gets the list of connections that the GatewayClient knows about.
getDescription() - Method in enum com.mmbnetworks.gatewayapi.exception.ExceptionCode
 
getDevice() - Method in class com.mmbnetworks.gatewayapi.event.device.DeviceEvent
Get the Device associated with the event.
getDevice(String) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Gets the device with the corresponding id.
getDeviceConnectionType() - Method in class com.mmbnetworks.gatewayapi.entity.Device
 
getDeviceIDs() - Method in interface com.mmbnetworks.gatewayapi.Group
Get all device IDs in this Group
getDevices(Predicate<Device>) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Returns a filtered collection of devices from all the networks that the GatewayClient knows about.
getDevices() - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Returns a collection of devices from all the networks that the GatewayClient knows about.
getDeviceType() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Get the DeviceType associated with the Device.
getDeviceType() - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Get the DeviceType associated with the Device.
getErrorCode() - Method in exception com.mmbnetworks.gatewayapi.exception.RequestException
Returns the error code associated with the exception
getFuture() - Method in class com.mmbnetworks.gatewayapi.PropertyCommandData
Gets the CompletableFuture representing the request to read/write the Property.
getGatewayDevices() - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Retrieves a collection of devices in the network that represents the network interface(i.e the ConnectionInfo that was passed upon the initialisation of the GatewayClient
getGroup() - Method in class com.mmbnetworks.gatewayapi.event.group.GroupEvent
Get the Group associated with the event.
getGroup(int) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Get the Group object with the associated id.
getGroup(int) - Method in interface com.mmbnetworks.gatewayapi.GroupManager
Get the Group object with the associated id
getGroupID() - Method in interface com.mmbnetworks.gatewayapi.Group
Get this Group's group ID
getGroupMembership() - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Get group membership of this Device.
getGroupName() - Method in interface com.mmbnetworks.gatewayapi.Group
Get this Group's group name
getHardwareVersion() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Retrieves the Hardware Version Of This Device.
getHardwareVersion() - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Retrieves the Hardware Version Of This Device.
getID() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Get the String identifier of this Device.
getId() - Method in class com.mmbnetworks.gatewayapi.event.UpgradeProgress
Gets the id of the device that is currently upgrading.
getInternalOtaHandler() - Method in class com.mmbnetworks.gatewayapi.GatewayClient
 
getManufacturerName() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Retrieves the Manufacturer Name Of This Device.
getManufacturerName() - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Retrieves the Manufacturer Name Of This Device.
getMax() - Method in class com.mmbnetworks.gatewayapi.entity.Property
Get the maximum value associated with this Property, which is immutable.
getMetaData() - Method in class com.mmbnetworks.gatewayapi.entity.Property
Get the meta data information associated with this Property
getMin() - Method in class com.mmbnetworks.gatewayapi.entity.Property
Get the minimum value associated with this Property, which is immutable.
getModelNumber() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Retrieves the Model Identifier Of This Device.
getModelNumber() - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Retrieves the Model Identifier Of This Device.
getName() - Method in enum com.mmbnetworks.gatewayapi.ConnectionInfo.ConnectionType
 
getName() - Method in class com.mmbnetworks.gatewayapi.entity.FunctionObject
 
getName() - Method in class com.mmbnetworks.gatewayapi.entity.Parameter
 
getName() - Method in class com.mmbnetworks.gatewayapi.entity.Property
Get the name of the Property, which is immutable.
getNetworkInfo(ConnectionInfo) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Returns the network information (status, channel, and id) of the specified network interface.
getParameters() - Method in class com.mmbnetworks.gatewayapi.entity.FunctionObject
 
getPayload() - Method in class com.mmbnetworks.gatewayapi.ZigBeeFrame
Returns the payload of this frame.
getPrimaryHeader() - Method in class com.mmbnetworks.gatewayapi.ZigBeeFrame
Returns the Primary Header of this frame, which represents the primary grouping
getProgress() - Method in class com.mmbnetworks.gatewayapi.event.UpgradeProgress
Gets the progress of an upgrade that is currently in progress.
getProperties() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Gets all currently known Property objects associated with this device type.
getProperty(String) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Gets the Property with the associated propertyName.
getProperty(String) - Method in interface com.mmbnetworks.gatewayapi.Group
Get the Property of devices in this Group.
getProtocolProperties() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Get all currently known protocolProperty for this device.
getRawPayload() - Method in class com.mmbnetworks.gatewayapi.ZigBeeFrame
Returns the pay of this frame.
getRegisteredOtaFiles(ConnectionInfo) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Gets a list of the OTA files registered on the OTA Server if an OTA server exists.
getSecondaryHeader() - Method in class com.mmbnetworks.gatewayapi.ZigBeeFrame
Returns the secondary header of this frame, which represents the actual frame within the primary grouping
getStatus() - Method in class com.mmbnetworks.gatewayapi.event.device.DeviceEvent
Get the DeviceEventStatus of the event.
getStatus() - Method in class com.mmbnetworks.gatewayapi.event.group.GroupEvent
Get the GroupEventStatus of the event.
getStatus() - Method in class com.mmbnetworks.gatewayapi.event.UpgradeProgress
Returns the status of the upgrade.
getTimeStamp() - Method in class com.mmbnetworks.gatewayapi.ZigBeeFrame
The Time Stamp Of When This Was Received or Sent out
getType() - Method in class com.mmbnetworks.gatewayapi.ConnectionInfo
Get the type of the connection represented by this object.
getType() - Method in class com.mmbnetworks.gatewayapi.entity.DeviceType
Gets the device type.
getType() - Method in class com.mmbnetworks.gatewayapi.entity.Property
Get the class type of the Property.
getUpgradeDelay() - Method in class com.mmbnetworks.gatewayapi.RateLimitPolicy
Retrieves the upgrade delay in seconds.
getUpgradeInterval() - Method in class com.mmbnetworks.gatewayapi.RateLimitPolicy
Retrieves the upgrade interval in milliseconds.
getValue() - Method in class com.mmbnetworks.gatewayapi.ConnectionInfo
Get the value associated with this object.
getValue() - Method in class com.mmbnetworks.gatewayapi.entity.Parameter
 
getValue() - Method in class com.mmbnetworks.gatewayapi.entity.Property
Get the value of this Property.
Group - Interface in com.mmbnetworks.gatewayapi
The Group is the interface through which all Device are added/removed from groups.
GroupEvent - Class in com.mmbnetworks.gatewayapi.event.group
An event associated with a Group.
GroupEvent(GroupEventStatus, Group) - Constructor for class com.mmbnetworks.gatewayapi.event.group.GroupEvent
Creates a GroupEvent object
GroupEventHandler - Interface in com.mmbnetworks.gatewayapi.event.group
The handler interface for receiving group events.
GroupEventStatus - Enum in com.mmbnetworks.gatewayapi.event.group
Enumerates the group events that can propagate from the GatewayClient.
GroupManager - Interface in com.mmbnetworks.gatewayapi
The GroupManager is the interface through which all Groups are created and removed.

H

hashCode() - Method in class com.mmbnetworks.gatewayapi.ConnectionInfo
 
hashCode() - Method in class com.mmbnetworks.gatewayapi.entity.DeviceType
 
hashCode() - Method in class com.mmbnetworks.gatewayapi.entity.Property
 

I

IasDeviceEventHandler - Class in com.mmbnetworks.gatewayapi.sample.iaszone
 
IasDeviceEventHandler() - Constructor for class com.mmbnetworks.gatewayapi.sample.iaszone.IasDeviceEventHandler
 
IasPropertyHandler - Class in com.mmbnetworks.gatewayapi.sample.iaszone
 
IasPropertyHandler() - Constructor for class com.mmbnetworks.gatewayapi.sample.iaszone.IasPropertyHandler
 
IasProtocolPassthroughHandler - Class in com.mmbnetworks.gatewayapi.sample.iaszone
 
IasProtocolPassthroughHandler() - Constructor for class com.mmbnetworks.gatewayapi.sample.iaszone.IasProtocolPassthroughHandler
 
IasZoneApp - Class in com.mmbnetworks.gatewayapi.sample.iaszone
This sample application demonstrates how one might use the GatewayClient to handle events from an IAS Zone device.
IasZoneApp() - Constructor for class com.mmbnetworks.gatewayapi.sample.iaszone.IasZoneApp
 
id - Variable in class com.mmbnetworks.gatewayapi.NetworkInformation
 
InternalOtaHandler - Class in com.mmbnetworks.gatewayapi
Internal OTA Handler facilitates handling the progress reporting of OTA upgrades and registering OTA files.
InvalidInputException - Exception in com.mmbnetworks.gatewayapi.exception
This exception class is used to report unexpected or invalid inputs to a method.
InvalidInputException(String) - Constructor for exception com.mmbnetworks.gatewayapi.exception.InvalidInputException
Construct an exception with the associated message.
InvalidInputException(Throwable) - Constructor for exception com.mmbnetworks.gatewayapi.exception.InvalidInputException
 
InvalidInputException(String, Throwable) - Constructor for exception com.mmbnetworks.gatewayapi.exception.InvalidInputException
 
isAllowAllUpgrades() - Method in class com.mmbnetworks.gatewayapi.UpgradePolicy
Retrieves the allow all upgrades parameter
isAllowDowngrade() - Method in class com.mmbnetworks.gatewayapi.UpgradePolicy
Retrieves the allow downgrade parameter
isAllowUpgrade() - Method in class com.mmbnetworks.gatewayapi.UpgradePolicy
Retrieves the allow upgrade parameter
isComplete() - Method in class com.mmbnetworks.gatewayapi.event.UpgradeProgress
Gets the status of an upgrade that is currently in progress.
isShutdown() - Method in class com.mmbnetworks.gatewayapi.GatewayClient
 

L

leaveNetwork() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Request the remote device to leave the network.
LightDevice - Class in com.mmbnetworks.gatewayapi.entity
 
LightDevice(DeviceModel, DeviceConnectionType, DialogueManager, Executor) - Constructor for class com.mmbnetworks.gatewayapi.entity.LightDevice
 

M

main(String[]) - Static method in class com.mmbnetworks.gatewayapi.sample.iaszone.IasZoneApp
 
main(String[]) - Static method in class com.mmbnetworks.gatewayapi.sample.SimpleCli
 
MAX_LEVEL_DECIMAL - Static variable in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
MAX_LEVEL_PERCENTAGE - Static variable in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
MAX_LEVEL_PERCENTAGE_DOUBLE - Static variable in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
MAX_LEVEL_TRANSITION_TIME - Static variable in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
MILLISECOND_MULTIPLIER - Static variable in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
MIN_LEVEL_PERCENTAGE - Static variable in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
MIN_LEVEL_TRANSITION_TIME - Static variable in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
moveToLevel(int) - Method in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
moveToLevel(int, int) - Method in class com.mmbnetworks.gatewayapi.entity.LightDevice
 

N

NAME - Static variable in class com.mmbnetworks.gatewayapi.entity.FunctionObject
 
NetworkInformation - Class in com.mmbnetworks.gatewayapi
 
NetworkStatus - Enum in com.mmbnetworks.gatewayapi
 

O

off() - Method in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
on() - Method in class com.mmbnetworks.gatewayapi.entity.LightDevice
 
onDeviceEvent(DeviceEvent) - Method in interface com.mmbnetworks.gatewayapi.event.device.DeviceEventHandler
Invoked when the DeviceEvent occurs.
onDeviceEvent(DeviceEvent) - Method in class com.mmbnetworks.gatewayapi.InternalOtaHandler
 
onDeviceEvent(DeviceEvent) - Method in class com.mmbnetworks.gatewayapi.sample.iaszone.IasDeviceEventHandler
 
onDeviceEvent(DeviceEvent) - Method in class com.mmbnetworks.gatewayapi.sample.SimpleCli
 
onError(Throwable) - Method in interface com.mmbnetworks.gatewayapi.event.ResultConsumer
Method Indicates An Erroneous State
onGroupEvent(GroupEvent) - Method in interface com.mmbnetworks.gatewayapi.event.group.GroupEventHandler
Invoked when the GroupEvent occurs.
onGroupEvent(GroupEvent) - Method in class com.mmbnetworks.gatewayapi.sample.SimpleCli
 

P

Parameter - Class in com.mmbnetworks.gatewayapi.entity
 
Parameter(String, String) - Constructor for class com.mmbnetworks.gatewayapi.entity.Parameter
 
PARAMETERS - Static variable in class com.mmbnetworks.gatewayapi.entity.FunctionObject
 
pauseOtaUpgrade(Device) - Method in class com.mmbnetworks.gatewayapi.InternalOtaHandler
Pauses an on-going ota upgrade.
ping() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Gets the round-trip latency information for a device, including last-hop LQI/RSSI if available.
Property - Class in com.mmbnetworks.gatewayapi.entity
Represents a property of a device, with a specific name and value.
Property(String, String, String) - Constructor for class com.mmbnetworks.gatewayapi.entity.Property
Creates a Property object with name as the identifier, and the value.
PropertyCommandData - Class in com.mmbnetworks.gatewayapi
Represents a request to read or write a Property.
PropertyCommandData(CompletableFuture<Property>) - Constructor for class com.mmbnetworks.gatewayapi.PropertyCommandData
 
PropertyCommandData(CompletableFuture<Property>, Property) - Constructor for class com.mmbnetworks.gatewayapi.PropertyCommandData
 

R

RateLimitPolicy - Class in com.mmbnetworks.gatewayapi
Rate Limit Policy facilitates handling the rate limit policy for OTA upgrades by defining the upgrade interval and upgrade delay.
RateLimitPolicy.RateLimitPolicyBuilder - Class in com.mmbnetworks.gatewayapi
Convenience builder class that facilitates the creation of rate limit policy
RateLimitPolicyBuilder() - Constructor for class com.mmbnetworks.gatewayapi.RateLimitPolicy.RateLimitPolicyBuilder
 
readAttribute(int, int) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Read a zigbee attribute that lives on a server cluster (and is not manufacturing specific).
readAttribute(int, int, int, boolean) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Read a zigbee attribute.
readCachedFanMode() - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Reads the cached FanControl.FanModeEnum of the Thermostat.
readCachedLevel() - Method in class com.mmbnetworks.gatewayapi.entity.LightDevice
Reads the cache level value of this light device.
readCachedOccupiedSetpoint(Thermostat.SetpointModeEnum) - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Reads the cached heating or cool setpoint of the thermostat device.
readCachedRunningMode() - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Reads the cached running mode of the thermostat device.
readCachedSystemMode() - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Reads the cached Thermostat.SystemModeEnum of the Thermostat.
readFanMode() - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Reads the current FanControl.FanModeEnum of the Thermostat.
readLevel() - Method in class com.mmbnetworks.gatewayapi.entity.LightDevice
Reads the current level of this light device
readOccupiedCoolingSetpoint() - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Reads the cooling setpoint.
readOccupiedHeatingSetpoint() - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Reads the heating setpoint.
readRunningMode() - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Reads the current running mode of the thermostat.
readSystemMode() - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Reads the current Thermostat.SystemModeEnum of the Thermostat.
registerGroupEventHandler(GroupEventHandler) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Allows a class to register itself to receive GroupEvent.
registerGroupEventHandler(GroupEventHandler) - Method in interface com.mmbnetworks.gatewayapi.GroupManager
Register the groupEventHandler so that it will receive the GroupEvent whenever a group is created, removed, or updated.
registerOtaFile(String, ConnectionInfo) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Registers an OTA file on the gateway if an OTA server exists.
registerOtaProgressHandler(Consumer<UpgradeProgress>) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Registers the OTA upgrade progress handler, which displays the progress when an upgrade starts.
registerReceivedZigBeeFrameListener(ConnectionInfo, Consumer<ZigBeeFrame>) - Method in class com.mmbnetworks.gatewayapi.ZigBeePassthroughManager
Registers a received frame listener
registerReceivedZigBeeMessageListener(ConnectionInfo, Consumer<ZigBeeFrame>) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Registers a received frame listener
registerSendZigBeeFrameListener(ConnectionInfo, Consumer<ZigBeeFrame>) - Method in class com.mmbnetworks.gatewayapi.ZigBeePassthroughManager
Registers a frame listener to listen in on sent frames
registerSendZigBeeMessageListener(ConnectionInfo, Consumer<ZigBeeFrame>) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Registers a frame listener to listen in on sent frames
removeAllDeviceEventHandlers() - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Removes all registered handlers.
removeAllPropertyUpdateHandlers() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Removes all handlers that have been previously registered.
removeAllProtocolHandlers() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Removes all handlers that have been previously registered.
removeDevice(Device) - Method in interface com.mmbnetworks.gatewayapi.Group
Remove a device from this Group.
removeDeviceEventHandler(DeviceEventHandler) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Removes a previously registered handler.
removeFromGroup(int) - Method in class com.mmbnetworks.gatewayapi.entity.Device
 
removeGroup(int) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Remove a group from this Device's group table.
removeGroup(Group) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Remove the Group object.
removeGroup(Group) - Method in interface com.mmbnetworks.gatewayapi.GroupManager
Remove the Group object from this GroupManager.
removePropertyUpdateHandler(BiConsumer<Device, Property>) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Removes a previously added handler.
removeProtocolHandler(BiConsumer<Device, String>) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Removes a previously added ProtocolHandler
RequestException - Exception in com.mmbnetworks.gatewayapi.exception
 
RequestException(int, String) - Constructor for exception com.mmbnetworks.gatewayapi.exception.RequestException
Construct an exception with the associated error code and message
resetRateLimitPolicy(Device) - Method in class com.mmbnetworks.gatewayapi.InternalOtaHandler
Resets the rate limit policy of an ota upgrade to default.
ResultConsumer<T> - Interface in com.mmbnetworks.gatewayapi.event
ResultConsumer adds the #onError(Throwable) method for situation when the producer needs to propagate some sort of error message, or exception to indicate an erroneous state

S

scanForDevices(ConnectionInfo, int) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Opens the permit join window on the specified network interface so that devices who are in pairing mode can join the network.
sendFrame(ConnectionInfo, ZigBeeFrame) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Sends a raw zigbee frame to the device
sendProtocolMessage(String) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Using this device this method will send a zigbee specific protocol message (ZCL, or ZDO).
sendProtocolMessage(ConnectionInfo, String) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Sends a protocol-specific message (i.e.
sendProtocolMessage(Object...) - Method in interface com.mmbnetworks.gatewayapi.Group
Send a zigbee specific protocol message (ZCL, or ZDO).
sendZclBroadcastCommand(String, short, byte[], int, int, boolean, boolean, boolean) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Sends a zcl broadcast command.
sendZclCommand(short, byte[], int) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Sends a zcl general command to a server cluster (that is not manufacturing specific).
sendZclCommand(short, byte[], int, int, boolean, boolean, boolean) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Sends a zcl command.
sendZclMulticastCommand(int, short, byte[], int, int, boolean, boolean, boolean) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Sends a zcl multicast command.
sendZigBeeFrame(ConnectionInfo, ZigBeeFrame) - Method in class com.mmbnetworks.gatewayapi.ZigBeePassthroughManager
Sends a raw zigbee frame to the device
setAllowAllUpgrades(boolean) - Method in class com.mmbnetworks.gatewayapi.UpgradePolicy.UpgradePolicyBuilder
Specifies if OTA upgrade or downgrade is allowed on all devices (i.e.
setAllowDowngrade(boolean) - Method in class com.mmbnetworks.gatewayapi.UpgradePolicy.UpgradePolicyBuilder
Specifies if OTA downgrade is allowed or not.
setAllowUpgrade(boolean) - Method in class com.mmbnetworks.gatewayapi.UpgradePolicy.UpgradePolicyBuilder
Specifies if OTA upgrade is allowed or not.
setConfigFilePath(String) - Method in class com.mmbnetworks.gatewayapi.GatewayClientBuilder
Sets the config file path for custom configs of gateway devices
setOccupiedCoolingSetpoint(double) - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Sets the cooling setpoint to a specific value.
setOccupiedHeatingSetpoint(double) - Method in class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
Sets the heating setpoint to a specific value.
setOtaUpgradeDelay(Duration) - Method in class com.mmbnetworks.gatewayapi.RateLimitPolicy.RateLimitPolicyBuilder
Sets a one time delay in the ota upgrade
setOtaUpgradeInterval(Duration) - Method in class com.mmbnetworks.gatewayapi.RateLimitPolicy.RateLimitPolicyBuilder
Sets the interval between every ota upgrade block
setOtaUpgradePolicy(UpgradePolicy) - Method in class com.mmbnetworks.gatewayapi.InternalOtaHandler
Sets the OTA upgrade policy of the OTA server.
setOtaUpgradeSpeed(int) - Method in class com.mmbnetworks.gatewayapi.RateLimitPolicy.RateLimitPolicyBuilder
Sets the speed of the ota upgrade
setRateLimitPolicy(Device, RateLimitPolicy) - Method in class com.mmbnetworks.gatewayapi.InternalOtaHandler
Sets the rate limit policy of an ota upgrade.
shutdown() - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Performs a graceful shut down of the GatewayClient, allowing for all subsystems to save any critical data and release system resources, such as file handles, open ports, etc.
SimpleCli - Class in com.mmbnetworks.gatewayapi.sample
This sample application demonstrates how one might use the GatewayClient to connect to a known network interface and interact with devices on it.
SimpleCli() - Constructor for class com.mmbnetworks.gatewayapi.sample.SimpleCli
 
startOtaUpgrade() - Method in class com.mmbnetworks.gatewayapi.entity.Device
Notify the remote device that an OTA image is available for upgrade.
startOtaUpgrade() - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Notify the remote device that an OTA image is available for upgrade.
status - Variable in class com.mmbnetworks.gatewayapi.NetworkInformation
 

T

ThermostatDevice - Class in com.mmbnetworks.gatewayapi.entity
 
ThermostatDevice(DeviceModel, DeviceConnectionType, DialogueManager, Executor) - Constructor for class com.mmbnetworks.gatewayapi.entity.ThermostatDevice
 
toJson() - Method in class com.mmbnetworks.gatewayapi.entity.FunctionObject
Constructs a json object for this function object
toString() - Method in class com.mmbnetworks.gatewayapi.ConnectionInfo
 
toString() - Method in class com.mmbnetworks.gatewayapi.entity.DeviceType
 
toString() - Method in class com.mmbnetworks.gatewayapi.entity.Property
 
toString() - Method in enum com.mmbnetworks.gatewayapi.exception.ExceptionCode
 
toString() - Method in class com.mmbnetworks.gatewayapi.NetworkInformation
 
toString() - Method in class com.mmbnetworks.gatewayapi.ZigBeeFrame
 

U

unbindDevice(String, String) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Removes the binding between this device (the source) and the destination device.
unpauseOtaUpgrade(Device) - Method in class com.mmbnetworks.gatewayapi.InternalOtaHandler
Unpauses an ota upgrade that was previously paused.
updateProperty(Property) - Method in class com.mmbnetworks.gatewayapi.entity.Device
Updates the Property associated with this device.
updateProperty(Property) - Method in interface com.mmbnetworks.gatewayapi.Group
Update the Property of devices in this Group.
upgradeFirmware(ConnectionInfo, File, ResultConsumer<UpgradeProgress>) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
Performs a firmware upgrade of the module with the given connectionInfo and serialUpgradeFile.
UpgradePolicy - Class in com.mmbnetworks.gatewayapi
 
UpgradePolicy.UpgradePolicyBuilder - Class in com.mmbnetworks.gatewayapi
Convenience builder class that facilitates the creation of upgrade policy
UpgradePolicyBuilder() - Constructor for class com.mmbnetworks.gatewayapi.UpgradePolicy.UpgradePolicyBuilder
 
UpgradeProgress - Class in com.mmbnetworks.gatewayapi.event
An object that contains the status of a serial or an OTA upgrade.
UpgradeProgress(double, boolean) - Constructor for class com.mmbnetworks.gatewayapi.event.UpgradeProgress
 
UpgradeProgress(double, boolean, String, UpgradeStatus) - Constructor for class com.mmbnetworks.gatewayapi.event.UpgradeProgress
 
UpgradeStatus - Enum in com.mmbnetworks.gatewayapi.entity
 

V

valueOf(String) - Static method in enum com.mmbnetworks.gatewayapi.ConnectionInfo.ConnectionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mmbnetworks.gatewayapi.entity.AccessControl
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mmbnetworks.gatewayapi.entity.DeviceConnectionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mmbnetworks.gatewayapi.entity.UpgradeStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mmbnetworks.gatewayapi.event.device.DeviceEventStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mmbnetworks.gatewayapi.event.group.GroupEventStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mmbnetworks.gatewayapi.exception.ExceptionCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mmbnetworks.gatewayapi.NetworkStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.mmbnetworks.gatewayapi.ConnectionInfo.ConnectionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mmbnetworks.gatewayapi.entity.AccessControl
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mmbnetworks.gatewayapi.entity.DeviceConnectionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mmbnetworks.gatewayapi.entity.UpgradeStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mmbnetworks.gatewayapi.event.device.DeviceEventStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mmbnetworks.gatewayapi.event.group.GroupEventStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mmbnetworks.gatewayapi.exception.ExceptionCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mmbnetworks.gatewayapi.NetworkStatus
Returns an array containing the constants of this enum type, in the order they are declared.
viewGroup(int) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
View a group's information of this Device

W

writeAttribute(int, int, short, byte[]) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Write to a zigbee attribute that lives on a server cluster (and is not manufacturing specific).
writeAttribute(int, int, short, byte[], int, boolean) - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
Write to a zigbee attribute.

Z

ZigbeeDevice - Class in com.mmbnetworks.gatewayapi.entity
Represents a zigbee device on the network.
ZigbeeDevice(DeviceModel, DeviceConnectionType, DialogueManager, Executor) - Constructor for class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
 
ZigBeeFrame - Class in com.mmbnetworks.gatewayapi
Represents a ZigBee Frame that is sent out or received
ZigBeeFrame(byte, byte, List<Byte>) - Constructor for class com.mmbnetworks.gatewayapi.ZigBeeFrame
Constructs a ZigBeeFrame object
ZigBeeFrame(byte, byte, byte[]) - Constructor for class com.mmbnetworks.gatewayapi.ZigBeeFrame
Constructs a ZigBeeFrame object
ZigBeeFrame(byte, byte, List<Byte>, LocalDateTime) - Constructor for class com.mmbnetworks.gatewayapi.ZigBeeFrame
Constructs a ZigBeeFrame object
ZigBeeGroupProtocolMessageRequest - Class in com.mmbnetworks.gatewayapi
 
ZigBeeGroupProtocolMessageRequest(int, int, byte[], boolean, boolean, boolean) - Constructor for class com.mmbnetworks.gatewayapi.ZigBeeGroupProtocolMessageRequest
Constructs a protocol requests specifical for Group.sendProtocolMessage(Object...)
ZigBeePassthroughManager - Class in com.mmbnetworks.gatewayapi
This manager is responsible for registering, and deregistering passthrough listener for listening in on RapidConnect frames.
ZigBeePassthroughManager(Executor, Collection<ConnectionInfo>, Function<ConnectionInfo, Optional<ZigBeePassthroughDevice>>) - Constructor for class com.mmbnetworks.gatewayapi.ZigBeePassthroughManager
Constructs the ZigBeePassthroughManager
A B C D E F G H I L M N O P R S T U V W Z 
Skip navigation links

Copyright © 2020. All rights reserved.