Click or drag to resize

CsaPws10sHubEnetBase Class

This base class is used for the CsaPws10sHubEnet and CsaPws10sHubEnetSlave. The CsaPws10sHubEnet is the an ethernet device, and the CsaPws10sHubEnetSlave is a device that can be dropped onto Cresnet or master/local branch of the CsaPws10sHubEnet.
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.GeneralIO
Assembly: Crestron.SimplSharpPro.GeneralIO (in Crestron.SimplSharpPro.GeneralIO.dll) Version: 2.21.121
Syntax
C#
public class CsaPws10sHubEnetBase : GenericDevice

The CsaPws10sHubEnetBase type exposes the following members.

Properties
 NameDescription
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 propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnablePowerReporting When set to true, this enables the reporting of the power levels on PowerUsageFeedback collections for each segment. This affects all segments. When false, reporting is disabled. It is disabled by default.
Public propertyFakeUpdateRequest Property to activate fake cresnet update request True = Active; False = InActive
Public propertyHubStatusFeedback Flag to indicate an action the hub is currently performing. See eCsaPws10sHubEnetStatus enum for further details.

The BaseEvent will trigger with HubStatusFeedbackEventId when this value changes.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInTestModeFeedback Flag to indicate if this hub is currently running a test.

The BaseEvent event will trigger with InTestModeFeedbackEventId.

Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyMasterSegmentDisableFeedback Property to indicate that the master segment is disabled.

The BaseEvent event will trigger with SegmentDisabledFeedbackEventId.

Remarks
true means the master segment is disabled, false means it is enabled. This value only will only change as a result of TestAllSegments being called.
Public propertyMasterSegmentFrameErrorFeedback Property to indicate that the master segment has experienced a framing error.

The BaseEvent event will trigger with SegmentFrameErrorFeedbackEventId.

Remarks
true means a framing error has occurred, false means none has occurred. The segment stays enabled when the error occurs.
Public propertyMasterSegmentStatusFeedback Property to indicate the results of test for the segment.

The BaseEvent event will trigger with SegmentStatusFeedbackEventId.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyOverTemperatureFeedback Flag to indicate that the device is running over safe temperature ratings.

The BaseEvent event will trigger with OverTemperatureFeedbackEventId.

Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPowerMinChange The value in 10s of milliWatts (mW) for reporting changes on the PowerUsageFeedback collections for each branch. This value affects reporting on all segments. Default value is 50, which is 500mW.
Public propertyPowerSupplyErrorStatusFeedback Flag to indicate an error on the hub power supply. See eCsaPws10sHubEnetPowerSupplyErrorStatus enum for further details.

The BaseEvent will trigger with PowerSupplyErrorStatusFeedbackEventId when this value changes.

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 propertySegments A collection of CsaPws10sHubEnetSegment objects. Each object contains information about an individual segment, such as the ability to power cycle and get status of the channels on the branch (failure mode and power usage), whether the branch is disabled, whether a framing error exists, the status of the branch. Note that the collection that contains information about the Cresnet devices on the hub is the Branches collection.
Public propertySegmentTestDoneFeedback Flag to indicate that all segment testing has completed.

The BaseEvent event will trigger with SegmentTestDoneFeedbackEventId.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyTestResultsFeedback Property to indicate the results of the segment test as textual information suitable for reporting to a touch panel, logging to a file, etc.

The BaseEvent event will trigger with TestResultsFeedbackEventId.

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)
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 methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
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 methodMemberwiseCloneCreates a shallow copy of the current Object.
(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 methodTestAllSegments Method to start electrical testing on all segments. The BaseEvent will trigger with the event ID InTestModeFeedbackEventId. When the test is complete, the same handler will trigger with the event ID SegmentTestDoneFeedbackEventId.
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 memberNumberOfSegments Number of segments on the CsaPws10sHubEnet and CsaPws10sHubEnetSlave devices.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also