Zummesh |
This class will trigger BaseEvent event with event IDs defined in ZummeshNetbridge. The Index will indicate the scene number for event ID SceneActiveEventId, In all other cases, it can be ignored.
public sealed class ZummeshNetbridge : GenericDevice, ICommonOccupancySensorInfo
The ZummeshNetbridge type exposes the following members.
| Name | Description | |
|---|---|---|
| ZummeshNetbridge | Constructor to create a new ZummeshNetbridge. |
| Name | Description | |
|---|---|---|
| BatteryLowFeedback |
Property to get the collection of devices whose battery level is low.
For the device info refer ZummeshNetbridgeDeviceInfo class.
The BaseEvent event will trigger with BatteryLowFeedbackEventId. | |
| BluetoothPinFeedback |
Property to report the pin for the bluetooth device.
This is the current 4-digit access code needed by a Bluetooth device to access this unit via Bluetooth
The default pin on the device is 2468.
The BaseEvent event will trigger with BluetoothPinFeedbackEventId. | |
| CctZone | Collection of CCT zones. Property to set/get values for CCT Zones. | |
| ConnectedIpList |
A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID.
This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null.
If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected.
The order of items in this list is not guaranteed.
(Inherited from GenericDevice) | |
| CurrentDaylightLevelFeedback |
Property to report the daylight level reported to the room's devices by the daylight sensor, if there is one.
The BaseEvent event will trigger with CurrentDaylightLevelFeedbackEventId. | |
| CurrentErrorsFeedback |
Property to return error log messages from the room, as they begin communicating with the room network.
The BaseEvent event will trigger with CurrentErrorsFeedbackEventId. | |
| CurrentTimeoutFeedback | Property to indicate which timeout is being used by the sensor. This property is not supported by ZummeshNetbridge. | |
| DaylightingEnabledFeedback |
Property to indicate if daylighting (daylight harvesting) is enabled in the room. This property will be
updated when Activate method is called for scene1 or when
DisableDaylighting or RoomAllOff methods are called or when Activate method is called for scenes 2-16.
The BaseEvent event will trigger with DaylightingEnabledEventId. | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| DeviceListFeedback |
Property to get the collection of devices that are communicating with the network.
For the device info refer ZummeshNetbridgeDeviceInfo class.
The BaseEvent event will trigger with DeviceListFeedbackEventId. | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| EUIDFeedback |
Property to report the unique identifier of the device.
The BaseEvent event will trigger with EUIDFeedbackEventId. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| ExportIdFeedback |
Property to return the export ID.
The BaseEvent event will trigger with ExportIdFeedbackEventId. The minimum firmware version on the device which supports this property is 1.014.0001. | |
| FirmwareLoadSuspendedFeedback |
Feedback to reflect the firmware loading state of the device.
The BaseEvent event will trigger with FirmwareLoadingSuspendedFeedbackEventId. | |
| FirmwareUpdateStatusFeedback |
Feedback to reflect the the overall upgrade status of a room
A value of false indicates that the system is idle, all updates completed or never requested since a bridge reboot which happens after bridge upgrades itself.
A value of true indicates that the update is pending.
The BaseEvent event will trigger with FirmwareUpdateStatusFeedbackEventId. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| FloorIdFeedback |
Property to return the current floor Id.
The BaseEvent event will trigger with FloorIdFeedbackEventId. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| FloorLabels | Property to get the collection of floor labels. | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| LoadShedEnable | Property to enable/disable Load Shedding. When "true" will enable Load Shedding. When set to "false", Load Shedding is disabled. This sends a signal to every load controller in the room telling it to go into Load Shedding mode. Basically Load Shedding Mode is a state where there is an alternate MAXimum value imposed on the dimmers as specified by LoadShedMaxLevel. For switch type controllers, it may tell the device that it needs to be off when Load Shedding is enabled. The minimum firmware version on the device which supports this property is v1.009.0012. | |
| LoadShedMaxLevel | Property to set the sets the maximum level of all dimmers. Used during load shedding to limit peak load which can cut on electricity costs. Valid range is 0 to 100. 0 being dimmer is off and 100 being max level. Default value is a 100. Use the "SimplSharpDeviceHelper.UshortToPercent" to convert the ushort value to percentage. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| MissingDevicesFeedback |
Property to get the collection of devices that have disappeared from the network.
For the device info refer ZummeshNetbridgeDeviceInfo class.
The BaseEvent event will trigger with MissingDevicesFeedbackEventId. | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| NumberOfDevicesFeedback |
Property to report the current number of active devices in the room. Reports each time the number changes.
The BaseEvent event will trigger with NumberOfDevicesFeedbackEventId. | |
| OccupancyDetectedFeedback |
Property to indicate if the room's logic determined that the room is occupied. Either from the sensors, or direct command.
The BaseEvent event will trigger with RoomOccupiedEventId. | |
| OccupancySensorEnabledFeedback |
Property to indicate if the room is instructed to act upon occupancy sensor events. Follows the calls to EnableOccupancySensor and DisableOccupancySensor methods.
The BaseEvent event will trigger with OccupancySensorEnabledEventId. | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| PlugControllerStatusFeedback |
Feedback to reflect the status of all the plug loads on the controller.
The BaseEvent event will trigger with PlugControllerStatusFeedbackEventId. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| Registerable |
Property to indicate that this device can be registered.
(Inherited from GenericDevice) | |
| Registered |
Property to get the current registration state of the device.
(Inherited from GenericDevice) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice) | |
| RemoteTimeout | Property to set timeout remotely. This property is not supported by ZummeshNetbridge. | |
| ResumeFirmwareLoad | Property to resume the firmware load operation on the controller. This will resume any pending updates on the device. The FirmwareLoadSuspendedFeedback will trigger to reflect the state of the controller. | |
| RoomIsOnFeedback |
Property to indicate if atleast one of the lights in the room is on.
The BaseEvent event will trigger with RoomIsOnEventId. | |
| RoomName | Property to set the name this bridge reports the room as. The string will also be stored in NV memory. | |
| RoomNameFeedback |
Property to report the name assigned to the room back to the control system.
The BaseEvent event will trigger with RoomNameFeedbackEventId. | |
| Scenes |
Collection of ZummeshNetbridgeZummeshNetbridgeScene class object.
This property will trigger BaseEvent with SceneActiveEventId. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| SolarSynchronizeActive | Property to enable/disable Solar Synchronize. Setting to 'True' enables Solar Synchronize, setting to 'False' will disable Solar Synchronize. | |
| SolarSynchronizeActiveFeedback |
Property to report the solar synchronize status.
True indicates solar synchronize is active, False indicates solar synchronize is deactive.
The BaseEvent event will trigger with SolarSynchronizeActiveFeedbackEventId. | |
| SuspendFirmwareLoad | Property to suspend the firmware load operation on the controller. This will suspend any pending updates on the device as long as the property is set to true. Setting the property to false will resume any pending updates. The FirmwareLoadSuspendedFeedback will trigger to reflect the state of the controller. | |
| Type |
Property to determine to type of device this is.
(Inherited from GenericDevice) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| VersionFeedback |
Property to report the version of the device.
The BaseEvent event will trigger with VersionFeedbackEventId. The minimum firmware version on the device which supports this property is v1.009.0012. | |
| XioEndpointStubSIMPLDevice |
The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the
correct place in hierarchy.
(Inherited from GenericDevice) | |
| ZoneIdFeedback |
Property to return the current zone Id.
The BaseEvent event will trigger with ZoneIdFeedbackEventId. The minimum firmware version on the device which supports this property is v1.008.0001. |
| Name | Description | |
|---|---|---|
| CancelFirmwareUpdate | Method to cancel all the pending updates. The FirmwareUpdateStatusFeedback will trigger to reflect the state of the controller. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| ClearErrors | Method to clear the error log in the bridge. | |
| ClearMissingDevices | Method to erase any record of the missing devices from the bridge. | |
| DisableDaylighting | Method to disable daylighting (daylight harvesting) in the room. (Can only be turned back on by calling the method Activate for scene1). | |
| DisableOccupancySensor | Method to instruct the room to not act upon occupancy sensor events, both real and forced. | |
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| EnableOccupancySensor | Method to instruct the room to act upon occupancy sensor events, both real and forced. | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Inherited from GenericDevice) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| OnBaseEvent(Int32) |
Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| PlugLoadOff | Method to turn off all the plug loads. The PlugControllerStatusFeedback will trigger to reflect the state of the controller. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| PlugLoadOn | Method to turn on all the plug loads. The PlugControllerStatusFeedback will trigger to reflect the state of the controller. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| RoomAllOff | Method to turn all the lights in the room off. This method will disable the daylighting (daylight harvesting) in the room also. | |
| SaveBluetoothPin | Method to save the bluetooth pin. Calling this method will instruct the device to assign the Desired Bluetooth PIN to the Bluetooth module. If the bluetooth pin is set, then the BluetoothPinFeedback will get reflected with the latest pin. | |
| SaveFloorAndZoneId | Method to save the floor and zone Id. The programmer needs to invoke the SetZoneId(UInt16) and SetFloorId(UInt16) before invoking this property. The default values for the Floor Id and Zone Id are 0. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| SetBluetoothPin | Property to set the bluetooth pin. This is a 4-digit access code you wish to assign to the Bluetooth module on the device. Valid values are 0 through 9999 inclusive. The default pin on the device is 2468. | |
| SetFloorId | Method to set the Floor Id. Valid values are 0 to 0xff. 0 indicates wildcard for the floor Id. The FloorIdFeedback will get updated to reflect the current floor Id. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| SetZoneId | Method to set the Zone Id. Valid values are 0 to 0xff. 0 indicates wildcard for the Zone Id. The ZoneIdFeedback will get updated to reflect the current Zone Id. The minimum firmware version on the device which supports this property is v1.008.0001. | |
| ToString |
Return the name of the device.
(Inherited from GenericDevice) | |
| UnRegister |
Unregister this device with the system. This function can not be called from the device's own SigChange event handler.
On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline. (Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| IpInformationChange |
Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device.
This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| BatteryLowFeedbackEventId |
The value of BatteryLowFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| BluetoothPinFeedbackEventId |
The value of BluetoothPinFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| CurrentDaylightLevelFeedbackEventId |
The value of CurrentDaylightLevelFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| CurrentErrorsFeedbackEventId |
The value of CurrentErrorsFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| DaylightingEnabledEventId |
The state of DaylightingEnabledFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| DeviceListFeedbackEventId |
The value of DeviceListFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| EUIDFeedbackEventId |
The value of EUIDFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| ExportIdFeedbackEventId |
The value of ExportIdFeedback has changed
The BaseEvent event will trigger for this event id. | |
| FirmwareLoadingSuspendedFeedbackEventId |
The value of FirmwareLoadSuspendedFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| FirmwareUpdateStatusFeedbackEventId |
The value of FirmwareUpdateStatusFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| FloorIdFeedbackEventId |
The value of FloorIdFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| MissingDevicesFeedbackEventId |
The value of MissingDevicesFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| NumberOfDevicesFeedbackEventId |
The value of NumberOfDevicesFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| OccupancySensorEnabledEventId |
The state of OccupancySensorEnabledFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| PlugControllerStatusFeedbackEventId |
The value of PlugControllerStatusFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| RoomIsOnEventId |
The state of RoomIsOnFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| RoomNameFeedbackEventId |
The value of RoomNameFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| RoomOccupiedEventId |
The state of OccupancyDetectedFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| SceneActiveEventId |
The state of ActiveFeedback has changed.
The BaseEvent event will trigger for this event id, Index will indicate the scene number. | |
| SolarSynchronizeActiveFeedbackEventId |
The value of SolarSynchronizeActiveFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| VersionFeedbackEventId |
The value of VersionFeedback has changed
The BaseEvent event will trigger for this event id. | |
| ZoneIdFeedbackEventId |
The value of ZoneIdFeedback has changed.
The BaseEvent event will trigger for this event id. |
static ZummeshNetbridge zumMeshDevice; public ControlSystemZummeshNetbridge() { //Register console commands CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a ZUMMESH-NETBRIDGE CreateDevice command", ConsoleAccessLevelEnum.AccessOperator); CrestronConsole.AddNewConsoleCommand(SetRoomNameCmd, "SetRoomName", "This is a ZUMMESH-NETBRIDGE SetRoomName command", ConsoleAccessLevelEnum.AccessOperator); } public void SetRoomNameCmd(String args) { zumMeshDevice.RoomName.StringValue = "ConferenceRoom"; } public void CreateDeviceCmd(String args) { //For internal gateway zumMeshDevice = new ZummeshNetbridge(0x3, ControllerRFGatewayDevice); zumMeshDevice.BaseEvent += ZummeshNetbridgeEventHandler; //Register the ZUMMESH-NETBRIDGE with the control system zumMeshDevice.Register(); } // Method to handle sig change events for ZUMMESH-NETBRIDGE Device. static void ZummeshNetbridgeEventHandler(GenericBase device, BaseEventArgs args) { if (args.EventId == ZummeshNetbridge.RoomIsOnEventId) { CrestronConsole.PrintLine("{0} Room Is On Event Occurred", device.ToString()); } else if (args.EventId == ZummeshNetbridge.SceneActiveEventId) { CrestronConsole.PrintLine("{0} Scene {1} Active Event Occurred", device.ToString(), args.Index); } else if (args.EventId == ZummeshNetbridge.MissingDevicesFeedbackEventId) { CrestronConsole.PrintLine("{0} Missing Devices Feedback Event Occurred", device.ToString()); for (uint i = 1; i <= zumMeshDevice.MissingDevicesFeedback.Count; i++) { CrestronConsole.PrintLine("MissingDevicesFeedback Device Address is {0}, Name is {1}, TSID is {2}", zumMeshDevice.MissingDevicesFeedback[i].ShortAddress, zumMeshDevice.MissingDevicesFeedback[i].Name, zumMeshDevice.MissingDevicesFeedback[i].TSID); } } }