Click or drag to resize

RFExSetupInformation Class

Extender to report setup information about the gateway.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProDeviceExtender
    Crestron.SimplSharpProRFExSetupInformation

Namespace: Crestron.SimplSharpPro
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public sealed class RFExSetupInformation : DeviceExtender

The RFExSetupInformation type exposes the following members.

Constructors
 NameDescription
Public methodRFExSetupInformation(CrestronDevice) Constructor to generate a new Setup Information extender.
Public methodRFExSetupInformation(CrestronDevice, String) Constructor to generate a new Setup Information extender.
Top
Properties
 NameDescription
Public propertyAcquiredDevices List to contain the devices acquired by the gateway.
Public propertyAcquireFeedback Sig to report the state of acquire. 'true' = in acquire mode.
Protected propertyBooleanInput Bool Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyBooleanOutput Bool Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyConsoleCmdRx Sig used to receive console command responses from the gateway.
Public propertyConsoleCmdTx Sig used to send console commands directly to the gateway.
Public propertyHostNameFeedback Reports the host name of the RF Gateway. This property is not supported by "CenGw1Sg" and returns NullStringOutputSig if not supported.
Public propertyPANIdFeedback Property to report the PANId for this current gateway
Public propertyRFChannel Sig used to change the RF Channel of the device.
Public propertyRFChannelFeedback Reports the current RF channel from 11 to 26.
Public propertyRFPower Sig used to set power level of the RF amplifier. Valid range of -43 to +3. This property is only supported by "CenGw1" and "CenGw1Sg".
Public propertyRFPowerFeedback Reports the power level of the RF amplifier. Valid range of -43 to +3.
Public propertySendAsyncDeviceInfo Enable/Disable reporting of Device Information from the gateway. If this is not enabled the AcquiredDevices list will not be accurate.
Protected propertyStringInput String Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyStringOutput String Outputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyUShortInput UShort Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyUShortOutput UShort Outputs on the device extender.
(Inherited from DeviceExtender)
Top
Methods
 NameDescription
Public methodAcquireOff Method to drop the gateway out of acquire mode.
Public methodAcquireOn Method to put the gateway in acquire mode.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitializeJoins Function to initialize the Sig Arrays
(Overrides DeviceExtenderInitializeJoins)
Protected methodMapAnalogInputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapAnalogOutputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapDigitalInputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapDigitalOutputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapSerialInputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapSerialOutputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Public methodMoveRFDevice(RFDeviceInformation, IExGateway) Method to move the device to a different gateway.
Public methodMoveRFDevice(RFDeviceInformation, UInt16, UInt16) Method to move the device to a different gateway.
Public methodRefreshAcquiredDeviceList Method to refresh the acquired device list.
Public methodSendConsoleCommandToGateway Method to send a console command to the gateway. Carriage return not needed. Do not issue this within a DeviceChange event handler.
Protected methodSendCueEventDataForDeviceExtender Function to fire the cue event information event for this extender.
(Overrides DeviceExtenderSendCueEventDataForDeviceExtender(SigEventArgs))
Public methodSetRFID Method to set the ID of the specified device. Do not issue this within a DeviceChange event handler.
Public methodSETRFIDByTSID Method to set the ID of the device using the specified TSID. Do not issue this within a DeviceChange event handler.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUse Set the extender as usable on the device. Call this method before registration of the device.
(Inherited from DeviceExtender)
Top
Events
 NameDescription
Public eventDeviceChange Event triggered when an device information has changed on the gateway.
Public eventDeviceExtenderSigChange Event to receive sig information intended for a device extender. When processing this event, it will hold off other sigs from being received from the device. If one desires to continue processing the data and receive more information, launch a new thread and allow this event to exit.
(Inherited from DeviceExtender)
Top
Fields
 NameDescription
Protected field_InUse Bool to determine if the extended is in use by the user.
(Inherited from DeviceExtender)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also