Analog Input (Dynamic)

Operator Menu Location: Generic Hardware Operators Dynamic Config Hardware

Operator Bitmap:

Functional Description:
This operator accepts a structure composition as an input, and outputs a structure to configure its operation. It must be linked to a hardware resource to complete its functionality.

Pin x accepts an input structure which configures the input value's characteristics. Refer to the Configuration Inputs section of the table below for the structure components and the accepted values.

Pin x accepts a boolean input which indicates when to accept the input, on a signal's rising or falling edge.

Pin y outputs a structure containing status information. Refer to the Data Outputs section of the table below for the structure components and the expected values.

Dynamic Configuration for Analog Inputs

Configuration Inputs
ID	Type	Name	Relevant Modes	Comments / Notes
1	int8	Input Mode	All	Specifies Voltage, Current, RTD, Resistance Modes // Analog Input Voltage Modes 0x11 0 to 20V 0x12 0 to 10V 0x14 0 to 5V 0x15 1 to 5V 0x17 0 to 1V 0x1A 0 to 100mV 0x1D 0 to 10mV 0x61 Differential +-1V (supported only on PCM-1 REV G and higher) // Analog Input Current Modes 0x21 0 to 20mA 0x22 4 to 20mA // Analog Input RTD Modes 0x41 PLATINUM, EUROPEAN CURVE, Deg C 0x42 PLATINUM, AMERICAN_CURVE, Deg C 0x43 PLATINUM, EUROPEAN CURVE, Deg F 0x44 PLATINUM, AMERICAN_CURVE, Deg F 0x45 CUSTOM RTD 0x45 0x46 NICKEL, Deg F 0x46 0x47 NICKEL, Deg C 0x47 // Analog Input Resistance Modes 0x51 0 to 2400OHM
2	bool	User-defined scaling	All	0 = Hardware defined 1 = User Defined Scaling
3	float	User-defined low range scaled equiv	All (If User-defined scaling enabled)
4	float	User-defined high range scaled equiv	All (If User-defined scaling enabled)
5	bool	Specify Sample Rate	All
6	float	Min Sample Rate	All	Value in Hz. Value is ignored unless "Specify Sample Rate" is true.
7	bool	Enable Undercurrent Detection	4-20mA mode only
8	float	Undercurrent Failsafe	4-20mA mode only
9	float	Overcurrent Failsafe	current modes
10	float	RTD Failsafe Temp	RTD modes
11	float	RTD R0	RTD "custom" only
12	float	RTD Alpha	RTD "custom" only
13	float	RTD Beta	RTD "custom" only
14	float	RTD Delta	RTD "custom" only
15	int8	RTD Scale	RTD "custom" only
16	float	Reserved1	All	This member is reserved for future expansion. To ensure compatibility with future Fairmount Automation software, this member should be set to zero (0.0).

Data Outputs
ID	Type	Name	Relevant Modes	Comments / Notes
1	int8	Status Code	All	Basic status information for the hardware. See "Status Codes" table on "Defines" worksheet.
2	int8	Mode	All	The input mode is echoed back to the data output block. This is intended mainly for networked operation, allowing the receiver to verify that the input is in the expected mode before interpreting data. Also useful when transitioning from one mode to another.
3	float	Analog Input Value	All
4	float	Actual Sample Rate	All	This is the input's actual sampling rate, if known. If the sampling rate is unknown, this value will be zero. Value is in Hz.
5	float	Reserved1	All	This member is reserved for future expansion. Until its meaning is defined by Fairmount Automation, applications should assume that its value is undefined.

User-Defined Properties:
Object Name. A string label that identifies the operator

Enable On. Defines at what segment of a signal the input should be read or indicates it is always active.

Comments: The following table defines the status codes in the Data Output structure:
.

Status Codes for Dynamic Configuration Generic Hardware Operators
Value	Name	Description
0	DYN_HW_STATUS_OK	Operator is behaving normally. No errors. Readings are safe to use.
1	DYN_HW_STATUS_CIRCUIT_WARNING	A fault has been detected in the circuit. For inputs, this may indicate an out-of-range reading. For outputs, this may indicate an overload condition. Readings returned (if any) may be "failsafe" values.
2	DYN_HW_STATUS_INITIALIZING	The hardware is initializing, and has not yet acquired valid readings. This can happen after the configuration has changed.
3	DYN_HW_STATUS_DISABLED	The hardware is set to an inactive mode, or has not yet been configured. Readings not valid.
4	DYN_HW_STATUS_USUPPORTED_CONFIG	The requested hardware configuration is unknown or is not supported by this hardware. Readings not valid.
5	DYN_HW_STATUS_RESOURCE_IN_USE	Some or all of the resources needed for the requested HW configuration are in use by other operators. Note: Certain HW modes require resources from multiple inputs or outputs. For example, PCM-1 Quad Decode and Event Timer modes require resources from both Digital Input 1 and 2. To use one of these two modes on the PCM-1, the other input must be in the "Disabled / Off" mode. Future Fairmount products may have similar "shared resource" limitations.
6	DYN_HW_STATUS_HW_FAULT	A major fault has been detected with the hardware resource. Readings not valid.

.
See Also: