Click or drag to resize

ZummeshNetbridge Class

Locus Network Bridge (ZUMMESH-NETBRIDGE) allows communication between an individual Locus network and a control processor through the InfinetEX network.

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.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.LightingZummeshNetbridge

Namespace: Crestron.SimplSharpPro.Lighting
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public sealed class ZummeshNetbridge : GenericDevice, 
	ICommonOccupancySensorInfo

The ZummeshNetbridge type exposes the following members.

Constructors
 NameDescription
Public methodZummeshNetbridge Constructor to create a new ZummeshNetbridge.
Top
Properties
 NameDescription
Public propertyBatteryLowFeedback 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.

Public propertyBluetoothPinFeedback 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.

Public propertyCctZone Collection of CCT zones. Property to set/get values for CCT Zones.
Public propertyConnectedIpList 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)
Public propertyCurrentDaylightLevelFeedback 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.

Public propertyCurrentErrorsFeedback Property to return error log messages from the room, as they begin communicating with the room network.

The BaseEvent event will trigger with CurrentErrorsFeedbackEventId.

Public propertyCurrentTimeoutFeedback Property to indicate which timeout is being used by the sensor. This property is not supported by ZummeshNetbridge.
Public propertyDaylightingEnabledFeedback 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.

Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDeviceListFeedback 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.

Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEUIDFeedback 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.
Public propertyExportIdFeedback 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.
Public propertyFirmwareLoadSuspendedFeedback Feedback to reflect the firmware loading state of the device.

The BaseEvent event will trigger with FirmwareLoadingSuspendedFeedbackEventId.

Public propertyFirmwareUpdateStatusFeedback 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.
Public propertyFloorIdFeedback 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.
Public propertyFloorLabels Property to get the collection of floor labels.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLoadShedEnable 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.
Public propertyLoadShedMaxLevel 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.
Public propertyMissingDevicesFeedback 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.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfDevicesFeedback 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.

Public propertyOccupancyDetectedFeedback 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.

Public propertyOccupancySensorEnabledFeedback 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.

Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPlugControllerStatusFeedback 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.
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Public propertyRemoteTimeout Property to set timeout remotely. This property is not supported by ZummeshNetbridge.
Public propertyResumeFirmwareLoad 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.
Public propertyRoomIsOnFeedback Property to indicate if atleast one of the lights in the room is on.

The BaseEvent event will trigger with RoomIsOnEventId.

Public propertyRoomName Property to set the name this bridge reports the room as. The string will also be stored in NV memory.
Public propertyRoomNameFeedback Property to report the name assigned to the room back to the control system.

The BaseEvent event will trigger with RoomNameFeedbackEventId.

Public propertyScenes Collection of ZummeshNetbridgeZummeshNetbridgeScene class object.

This property will trigger BaseEvent with SceneActiveEventId.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySolarSynchronizeActive Property to enable/disable Solar Synchronize. Setting to 'True' enables Solar Synchronize, setting to 'False' will disable Solar Synchronize.
Public propertySolarSynchronizeActiveFeedback 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.

Public propertySuspendFirmwareLoad 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.
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Public propertyVersionFeedback 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.
Protected propertyXioEndpointStubSIMPLDevice 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)
Public propertyZoneIdFeedback 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.
Top
Methods
 NameDescription
Public methodCancelFirmwareUpdate 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.
Public methodClearErrors Method to clear the error log in the bridge.
Public methodClearMissingDevices Method to erase any record of the missing devices from the bridge.
Public methodDisableDaylighting Method to disable daylighting (daylight harvesting) in the room. (Can only be turned back on by calling the method Activate for scene1).
Public methodDisableOccupancySensor Method to instruct the room to not act upon occupancy sensor events, both real and forced.
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEnableOccupancySensor Method to instruct the room to act upon occupancy sensor events, both real and forced.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Public methodPlugLoadOff 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.
Public methodPlugLoadOn 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.
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodRoomAllOff Method to turn all the lights in the room off. This method will disable the daylighting (daylight harvesting) in the room also.
Public methodSaveBluetoothPin 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.
Public methodSaveFloorAndZoneId 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.
Public methodSetBluetoothPin 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.
Public methodSetFloorId 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.
Public methodSetZoneId 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.
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnRegister 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)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventIpInformationChange 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)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top
Fields
 NameDescription
Public fieldStatic memberBatteryLowFeedbackEventId The value of BatteryLowFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberBluetoothPinFeedbackEventId The value of BluetoothPinFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCurrentDaylightLevelFeedbackEventId The value of CurrentDaylightLevelFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCurrentErrorsFeedbackEventId The value of CurrentErrorsFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDaylightingEnabledEventId The state of DaylightingEnabledFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDeviceListFeedbackEventId The value of DeviceListFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberEUIDFeedbackEventId The value of EUIDFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberExportIdFeedbackEventId The value of ExportIdFeedback has changed

The BaseEvent event will trigger for this event id.

Public fieldStatic memberFirmwareLoadingSuspendedFeedbackEventId The value of FirmwareLoadSuspendedFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberFirmwareUpdateStatusFeedbackEventId The value of FirmwareUpdateStatusFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberFloorIdFeedbackEventId The value of FloorIdFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberMissingDevicesFeedbackEventId The value of MissingDevicesFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberNumberOfDevicesFeedbackEventId The value of NumberOfDevicesFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberOccupancySensorEnabledEventId The state of OccupancySensorEnabledFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPlugControllerStatusFeedbackEventId The value of PlugControllerStatusFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRoomIsOnEventId The state of RoomIsOnFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRoomNameFeedbackEventId The value of RoomNameFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRoomOccupiedEventId The state of OccupancyDetectedFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSceneActiveEventId The state of ActiveFeedback has changed.

The BaseEvent event will trigger for this event id, Index will indicate the scene number.

Public fieldStatic memberSolarSynchronizeActiveFeedbackEventId The value of SolarSynchronizeActiveFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberVersionFeedbackEventId The value of VersionFeedback has changed

The BaseEvent event will trigger for this event id.

Public fieldStatic memberZoneIdFeedbackEventId The value of ZoneIdFeedback has changed.

The BaseEvent event will trigger for this event id.

Top
Example
C#
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);
        }
    }
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also