- 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.
- 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
- 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
-
- 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
-
- getDeviceType() - Method in class com.mmbnetworks.gatewayapi.entity.ZigbeeDevice
-
- 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
- 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.
- 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
-
- 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
.
- getProtocolProperties() - Method in class com.mmbnetworks.gatewayapi.entity.Device
-
Get all currently known protocol
Property
for this device.
- 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.
- getStatus() - Method in class com.mmbnetworks.gatewayapi.event.device.DeviceEvent
-
Get the DeviceEventStatus of the event.
- getStatus() - Method in class com.mmbnetworks.gatewayapi.event.UpgradeProgress
-
Returns the status of the upgrade.
- 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.
- 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.
- 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.
- 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.
- 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.
- removeDeviceEventHandler(DeviceEventHandler) - Method in class com.mmbnetworks.gatewayapi.GatewayClient
-
Removes a previously registered handler.
- removeFromGroup(int) - Method in class com.mmbnetworks.gatewayapi.entity.Device
-
- 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
- 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
- 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.
- 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.
- 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.
- 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.
- 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
-
- 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.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.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.