Access the Module object

The Module object provides status information about a module. To select a particular Module object, set the Object Name operand of the GSV/SSV instruction to the module name. The specified module must be present in the I/O Configuration section of the controller organizer and must have a device name.
Attribute
Data Type
Instruction
Description
EntryStatus
INT
GSV
Specifies the current state of the specified map entry. The lower 12 bits should be masked when performing a comparison operation. Only bits 12...15 are valid. Each value has a specific meaning:
  • 16#0000. Standby.
     The controller is powering up.
  • 16#1000. Faulted.
    Any of the Module object’s connections to the associated module fail. This value should not be used to determine if the module failed because the Module object leaves this state periodically when trying to reconnect to the module. Instead, test for Running state (16#4000). Check for FaultCode not equal to 0 to determine if a module is faulted. When Faulted, the FaultCode and FaultInfo attributes are valid until the fault condition is corrected.
  • 16#2000. Validating.
     The Module object is verifying Module object integrity prior to establishing connections to the module.
  • 16#3000. Connecting.
     The Module object is initiating connections to the module.
  • 16#4000. Running.
     All connections to the module are established and data is transferring.
  • 16#5000. Shutting down.
     The Module object is in the process of shutting down all connections to the module.
  • 16#6000. Inhibited.
     The Module object is inhibited (the inhibit bit in the Mode attribute is set).
  • 16#7000. Waiting.
     The parent object upon which this Module object depends is not running.
  • 16#9000. Firmware Updating.
     Firmware supervisor is attempting to flash the module.
  • 16#A000. Configuring.
     Controller is downloading configuration to the module.
FaultCode
INT
GSV
A number that identifies a module fault, if one occurs.
FaultInfo
DINT
GSV
Provides specific information about the Module object fault code.
Firmware
SupervisorStatus
INT
GSV
Identifies current operating state of the firmware supervisor feature. Each value has specific meaning:
  • 0. Module updates are not being executed.
  • 1. Module updates are being executed.
ForceStatus
INT
GSV
Specifies the status of forces. Each bit has specific meaning:
  • 0. Forces installed (1=yes, 0-no).
  • 1. Forces enabled (1=yes, 0=no).
Instance
DINT
GSV
Provides the instance number of this module object.
LEDStatus
INT
GSV
Specifies the current state of the I/O status indicator on the front of the controller.(1) Each value has a specific meaning:
  • 0. Status indicator off: No Module objects are configured for the controller. (There are no modules in the I/O Configuration section of the controller organizer.)
  • 1. Flashing red: None of the Module objects are Running.
  • 2. Flashing green: At least one Module object is not Running.
  • 3. Solid green: All the Module objects are Running.
You do not enter an object name with this attribute because this attribute applies to the entire collection of modules.
Mode
INT
GSV SSV
Specifies the current mode of the Module object. Each bit has a specific meaning:
  • 0. If set, causes a major fault to be generated if any of the Module object connections fault while the controller is in Run mode.
  • 2. If set, causes the Module object to enter Inhibited state after shutting down all the connections to the module.
Path
SINT Array
GSV
Specifies the path to the module being referenced. This is a new attribute starting in version 24 software. Each byte has a specific meaning:
  • 0-1. Length of the path in bytes. If 0, length of the SINT array is insufficient to hold the returned module path.
If SINT array length is insufficient to hold the path, the array is zeroed out, and a minor fault is logged.
(1) The 1756-L7x controllers do not have a status indicator display on the front of the controller, but do use this functionality.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.