Relay (Dynamic)

Operator Menu Location: Generic Hardware Operators -> Dynamic Config Hardware

Operator Bitmap:

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

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

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

Pin x3 accepts an input structure containing the relay's output state. Refer to the Data Inputs section of the table below for the structure components and the accepted values.

Pin y1 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 Relays

Configuration Inputs
ID	Type	Name	Relevant Modes	Comments / Notes
1	int8	Output Mode	All	0 = Relay Disabled / Off 1 = DC Mode 2 = AC Mode
2	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 Inputs
ID	Type	Name	Relevant Modes	Comments / Notes
1	bool	Output State	All
2	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 output 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	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: