Click or drag to resize

FusionRoom Class

Fusion help desk software provides facility-wide network control of AV resources in real time.

This class will trigger FusionStateChange and FusionAssetStateChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Fusion
Assembly: Crestron.SimplSharpPro.Fusion (in Crestron.SimplSharpPro.Fusion.dll) Version: 2.21.121
Syntax
C#
public sealed class FusionRoom : FusionBase

The FusionRoom type exposes the following members.

Constructors
 NameDescription
Public methodFusionRoom Constructor to generate a new Crestron FusionRoom device.
Top
Properties
 NameDescription
Public propertyAuthenticateFailed Property to return the AuthenticateFailed sig details. The AuthenticateFailed has output sig only and is used to indicate the result (failed) of a credentials authentication request (made via the Fusion Serials asset).

The FusionStateChange event will trigger with AuthenticateFailedReceivedEventId.

Public propertyAuthenticateRequest Property to return the AuthenticateRequest sig details. The AuthenticateRequest has only input sig and used to send Windows domain credentials to Fusion for authentication against Active Directory.
Public propertyAuthenticateSucceeded Property to return the AuthenticateSucceeded sig details. The AuthenticateSucceeded has output sig only and is used to indicate the result (succeeded) of a credentials authentication request (made via the Fusion Serials asset).

The FusionStateChange event will trigger with AuthenticateSucceededReceivedEventId.

Public propertyBroadcastMessage Property to return the BroadcastMessage sig details. The BroadcastMessage has both input and output sigs. Input sig is used to send the corresponding broadcast message response to Fusion and output sig is used to receive broadcast message from Fusion.

The FusionStateChange event will trigger with BroadcastMessageReceivedEventId.

Public propertyBroadcastMessageType Property to return the BroadcastMessageType sig details. The BroadcastMessageType has only output sig, and is used to receive the broadcast message type.

The FusionStateChange event will trigger with BroadcastMessageTypeReceivedEventId.

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 propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDeviceUsage Property to return the DeviceUsage sig details. The DeviceUsage has only input sig and used to send the Device usage serial data to the Fusion database. This data is included in any Device Usage report that is generated with Fusion.
Public propertyDisplayPowerOff Property to return the DisplayPowerOff sig details. The DisplayPowerOff has output sig only and is used to indicate that the display power is off.

The FusionStateChange event will trigger with DisplayPowerOffReceivedEventId.

Public propertyDisplayPowerOn Property to return the DisplayPowerOn sig details. The DisplayPowerOn has both input and output sigs. The input sig is used to activate the feedback for the Display Power status field in RoomView and the output sig is used to indicate that the display power is on.

The FusionStateChange event will trigger with DisplayPowerOnReceivedEventId.

Public propertyDisplayUsage Property to return the DisplayUsage sig details. The DisplayUsage has only input sig, and is used to set the lamp life of the display device. This value is routed to the Display Usage field in Fusion.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyErrorMessage Property to return the ErrorMessage sig details. The ErrorMessage has only input sig and is used to send a formatted error message to Fusion, which displays a different icon in the Log field depending on the severity of the error.
Public propertyExtenderFusionRoomDataReservedSigs Property to access the FusionRoomDataReservedSigs functionality of the FusionBase device.

This property will trigger DeviceExtenderSigChange event.


(Inherited from FusionBase)
Public propertyExtenderRoomViewSchedulingDataReservedSigs Property to access the RoomViewSchedulingDataReservedSigs functionality of the FusionBase device.

This property will trigger DeviceExtenderSigChange event.


(Inherited from FusionBase)
Public propertyFreeBusyStatusToRoom Property to return the FreeBusyStatusToRoom sig details. The FreeBusyStatusToRoom has only input sig, and used to set the Free/busy status. This input should be connected to the corresponding output of the Crestron module, RVSE2_Single_Interface_vX.X. This module is part of the RoomView Server Edition (RVSE) software support library.
Public propertyGroupMembership Property to return the GroupMembership sig details. The GroupMembership has only output sig and used to report the user's domain groups as the result of a successful domain credentials authentication.

The FusionStateChange event will trigger with GroupMembershipRequestReceivedEventId.

Public propertyHelp Property to return the Help sig details. The Help has both input and output sigs. Input sig is to receive help request from a room. Output sig is to send a pre-defined or custom help response back to the room Touchscreen that requested help.

The FusionStateChange event will trigger with HelpMessageReceivedEventId.

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 propertyLogText Property to to return the LogText sig details. LogText has only input sig and used to send the corresponding serial data to the signal log table in the Fusion database.
Public propertyMessageBroadcastEnabled Property to return the MessageBroadcastEnabled sig details. The MessageBroadcastEnabled has input sig only and is used to enable message broadcasting to all connected rooms.
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParameterInstanceID Parameter to access the Instance ID of the corresponding room in Fusion, which is read-only field used by Fusion that cannot be edited.
Public propertyParameterRoomName Parameter to access the display name of the corresponding room in Fusion.
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
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)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySystemPowerOff Property to return the SystemPowerOff sig details. The SystemPowerOff output sig only and is used to indicate that the system power is off.

The FusionStateChange event will trigger with SystemPowerOffReceivedEventId.

Public propertySystemPowerOn Property to return the SystemPowerOn sig details. The SystemPowerOn has both input and output sigs. The input sig is used to activate the feedback for the System Power status field in RoomView. The output sig is used to indicate that the system power is on.

The FusionStateChange event will trigger with SystemPowerOnReceivedEventId.

Public propertyTextMessage Property to return the TextMessage sig details. The TextMessage has both input and output sigs. Input sig is used to send the serial string as an instant text message to Fusion and the output sig is used to receive instant text message from Fusion.

The FusionStateChange event will trigger with TextMessageFromRoomReceivedEventId.

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 propertyUserDefinedBooleanSigDetailsBooleanSigData collection for storing the BooleanSigData for User Configurable Bool Sig details.

The FusionStateChange event will trigger with UserConfiguredBoolSigChangeEventId for User defined Bool Output Sig state changes.

Public propertyUserDefinedStringSigDetailsStringSigData collection for storing the StringSigData for User Configurable String Sig details.

The FusionStateChange event will trigger with UserConfiguredStringSigChangeEventId for User defined String Output Sig value changes.

Public propertyUserDefinedUShortSigDetailsUShortSigData collection for storing the UShortSigData for User Configurable UShort Sig details.

The FusionStateChange event will trigger with UserConfiguredUShortSigChangeEventId for User defined UShort Output Sig value changes.

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
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)
Top
Methods
 NameDescription
Public methodAddAsset Method to add user configurable asset to the corresponding collection. This will override and previous configuration for the specified number. The valid asset numbers are from 1 to 249. The name for ShadePresets asset is predefined and user passed name will be ignored. The type name of all assets is predefined except for FusionDynamicAsset and FusionStaticAsset assets and user passed type name will be ignored for those assets whose asset type name is predefined.
Public methodAddSig(eSigType, UInt32, String, eSigIoMask) Method to add user configurable sig of the predefined assets to the corresponding collection. This will override any previous configuration for the specified number. The valid sig numbers are from 1 and 24951.
Public methodAddSig(UInt32, eSigType, UInt32, String, eSigIoMask) Method to add user configurable sig to the specified user configurable asset sig collection. This will override and previous configuration for the specified number. The valid sig numbers are from 1 to 24951 for FusionDynamicAssetFusionGenericAssetDigitals Sub-asset of FusionDynamicAsset. The valid sig numbers are from 1 to 24951 for FusionDynamicAssetFusionGenericAssetAnalogs Sub-asset of FusionDynamicAsset. The valid sig numbers are from 1 to 24951 for FusionDynamicAssetFusionGenericAssetSerials Sub-asset of FusionDynamicAsset. The valid sig numbers are from 1 to 15 for FusionLightingScenesFusionLightingSceneNames Sub-asset of FusionLightingScenes. The valid sig numbers are from 1 to 84 for FusionRemoteRealTimePowerFusionAssetsRealTimePower Sub-asset of FusionRemoteRealTimePower. These are all input only Sigs. The valid sig numbers are from 1 to 16 for FusionShadePresetsFusionShadePresetNames Sub-asset of FusionShadePresets. The valid sig numbers are from 1 to 24951 for FusionStaticAssetFusionGenericAssetDigitals Sub-asset of FusionStaticAsset. The valid sig numbers are from 1 to 24951 for FusionStaticAssetFusionGenericAssetAnalogs Sub-asset of FusionStaticAsset. The valid sig numbers are from 1 to 24951 for FusionStaticAssetFusionGenericAssetSerials Sub-asset of FusionStaticAsset.
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to remove the FusionBase device from collection.
(Inherited from FusionBase)
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 methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodRemoveAllSigs Method to remove all user configured sigs of predefined assets from all the collections.
Public methodRemoveAllSigs(UInt32) Method to remove all user configured sigs from the specified user configurable asset sig collection.
Public methodRemoveAsset Method to remove user configured asset from the corresponding collection. The valid asset numbers are from 1 to 249.
Public methodRemoveSig(eSigType, UInt32) Method to remove user configured sig from the corresponding collection. Both input and output sigs corresponding to the sig number passed will be removed. The valid sig numbers are from 1 to 24951 for FusionDynamicAssetFusionGenericAssetDigitals Sub-asset of FusionDynamicAsset. The valid sig numbers are from 1 to 24951 for FusionDynamicAssetFusionGenericAssetAnalogs Sub-asset of FusionDynamicAsset. The valid sig numbers are from 1 to 24951 for FusionDynamicAssetFusionGenericAssetSerials Sub-asset of FusionDynamicAsset. The valid sig numbers are from 1 to 15 for FusionLightingScenesFusionLightingSceneNames Sub-asset of FusionLightingScenes. The valid sig numbers are from 1 to 84 for FusionRemoteRealTimePowerFusionAssetsRealTimePower Sub-asset of FusionRemoteRealTimePower. These are all input only Sigs. The valid sig numbers are from 1 to 16 for FusionShadePresetsFusionShadePresetNames Sub-asset of FusionShadePresets. The valid sig numbers are from 1 to 24951 for FusionStaticAssetFusionGenericAssetDigitals Sub-asset of FusionStaticAsset. The valid sig numbers are from 1 to 24951 for FusionStaticAssetFusionGenericAssetAnalogs Sub-asset of FusionStaticAsset. The valid sig numbers are from 1 to 24951 for FusionStaticAssetFusionGenericAssetSerials Sub-asset of FusionStaticAsset.
Public methodRemoveSig(UInt32, eSigType, UInt32) Method to remove user configurable sig from the specified user configurable asset sig collection. Both input and output sigs corresponding to the sig number passed will be removed. The valid sig numbers are from 1 and 24951.
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 eventFusionAssetStateChange Event triggered when the Crestron FusionRoom reports information to the Control System.

Valid event IDs are available in FusionAssetEventId

Public eventFusionStateChange Event triggered when the Crestron FusionBase reports information to the Control System.
(Inherited from FusionBase)
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 fieldUserConfigurableAssetDetailsCustomFusionAssetData collection for User Configurable Asset details for Crestron FusionRoom

The FusionAssetStateChange event will trigger with FusionAssetEventId for User defined Asset Output Sig state/value changes.

Top
Example
C#
// Private Member variables.
#region Private member variables
private static FusionRoom _room;

/// Initializes all objects and event listeners.
/// This function should be called within you ControlSystem class.
public static bool InitializeDevice(CrestronControlSystem controller)
{
    bool returnValue = false;

    // If the controller is null, then return and report an error to the control system log.
    if (controller == null)
    {
        ErrorLog.Error("Error with control system. Aborting initialization");
        return returnValue;
    }

    try
    {
        // Construct our room object with IP_ID, control system, name, and GUID. 
        _room = new FusionRoom(0x04, controller, "conference room", "0000");

        // Set the description of the room. This will appear on Fusion's UI.
        _room.Description = "first floor conference room.";

        // Add our assets to the Fusion room, check if function execution was successful.
        if (addAsset())
        {
            ErrorLog.Notice("Assets created at: {0}", DateTime.Now.ToString());
        }
        // If there is an error, send a message to the log.
        else
            ErrorLog.Notice("Assets not created.");

        // Set up Fusion Room event handlers.
        _room.FusionAssetStateChange += new FusionAssetStateEventHandler(room_FusionAssetStateChange);

        _room.FusionStateChange += new FusionStateEventHandler(room_FusionStateChange);

        _room.OnlineStatusChange += new OnlineStatusChangeEventHandler(OnlineStatusChange);

        // Reserve signals being using.
        _room.ExtenderFusionRoomDataReservedSigs.Use();

        _room.ExtenderFusionRoomDataReservedSigs.DeviceExtenderSigChange += new DeviceExtenderJoinChangeEventHandler(ExtenderFusionRoomDataReservedSigs_DeviceExtenderSigChange);

        // Send a message to Fusion log that the system has come online.
        _room.LogText.InputSig.StringValue = "System initializing at: " + DateTime.Now.ToString();

        // After the room, and assets are setup then we can register our fusion room.
        // IMPORTANT, do not generate the RVI file after devices registration. There will be problems with your Fusion objects being loaded.
        FusionRVI.GenerateFileForAllFusionDevices();

        // Register the room. With Fusion.
        if (_room.Register() != eDeviceRegistrationUnRegistrationResponse.Success)
        {
            ErrorLog.Error("Could not register Fusion room: {0}", _room.Name);
        }

        // Finally, set the returnValue to true as execution has reached the end of the function.
        returnValue = true;
    }
    catch (Exception e)
    {
        ErrorLog.Error("Error while Initializing fusion room: {0}, {1}", e.Message.ToString(), e.StackTrace);
        // If an error occurs during Initialization, flag our return values as false. 
        returnValue = false;
    }

    // Return the status of the function execution.
    return returnValue;
}

/// Add our assets to the Fusion room. Each Asset can be a variety of types 
/// For more info on each asset type, go to Fusion's SSI guide.
/// Assets store information about each devices (1:1).
private static bool addAsset()
{
    bool returnValue = false;

    try
    {
        // IMPORTANT: when adding assets, the instance id must be unique, if it is not
        // fusion will override the old asset with the most recent asset with the same ID.  

        // Add an asset to the room with the type of Static Asset. With the type of TouchPanel.
        _room.AddAsset(eAssetType.StaticAsset, _touchPanelId, "TSW752", "Touchpanel", "0003");

        // Add an asset to the room with the type of Static Asset. With the type of Computer.
        _room.AddAsset(eAssetType.StaticAsset, _laptopId, "Thinkpad", "Computer", "0004");

        // Add an asset to the room with the type Static asset, with the type of Display.
        _room.AddAsset(eAssetType.StaticAsset, _displayId, "mainDisplay", "Display", "0005");

        //return the status of the function's execution.
        returnValue = true;
    }
    catch (Exception e)
    {
        ErrorLog.Error("Error while creating Asset: {0}, {1}", e.Message.ToString(), e.StackTrace);

        // Flag our return value as false since execution has reached the exception block.
        returnValue = false;
    }

    // Return the boolean indicating the success of the function's execution.
    return returnValue;
}

// Event handler for checking when a room comes oneline
private static void OnlineStatusChange(GenericBase currentDevice, OnlineOfflineEventArgs args)
{
    if (args.DeviceOnLine)
    {
        ErrorLog.Notice("{0} is online at: {1}", currentDevice.Description, DateTime.Now.ToString());
    }
    else
    {
        ErrorLog.Notice("{0} is offline", currentDevice.Description);
    }
}

// Event listener for device extender.
private static void ExtenderFusionRoomDataReservedSigs_DeviceExtenderSigChange(DeviceExtender currentDeviceExtender, SigEventArgs args)
{
    ErrorLog.Notice("extender signal change: {0}", args.Sig.Name);
}

// State change event handler for Fusion Rooom.
private static void room_FusionStateChange(FusionBase device, FusionStateEventArgs args)
{
    // goes through each event id.
    switch (args.EventId)
    {
        // If display power is turned off then we must flag it as offline and turn off the display.
        case FusionEventIds.DisplayPowerOffReceivedEventId:

            break;

        // If power to the display is turned on then we turn our display on and 
        // flag it as online.
        case FusionEventIds.DisplayPowerOnReceivedEventId:

            break;

        // If system power is turned on then we mark is as on.
        case FusionEventIds.SystemPowerOnReceivedEventId:

            break;

        // If the system is turned off from fusion then we mark it as offline and 
        // turn off all connected devices.
        case FusionEventIds.SystemPowerOffReceivedEventId:

            break;

       }

       // print the EventId sent to the control system by fusion.
       CrestronConsole.PrintLine("Event Id: {0}", args.EventId.ToString());
   }
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also