Y_ReadStringParameter
This Function Block returns the string value of an axis-specific parameter.
Refer to parameters with STRING Data Type in the Axis Parameter List. The two parameters available are .AmplifierModel (1819) and MotorModel (1823)
Parameters
| * | Parameter | Data Type | Description | Default |
|---|---|---|---|---|
| VAR_IN_OUT | ||||
| B | Axis | AXIS_REF | Logical axis reference. This value can be located on the Configuration tab in the Hardware Configuration (logical axis number). | |
| VAR_INPUT | ||||
| B | Execute | BOOL | Upon the rising edge, all other function block inputs are read and the function is initiated. To modify an input, change the value and re-trigger the execute input. | FALSE |
| V | ParameterNumber | UINT | Controller parameter number. Refer to parameters with STRING Data Type in the Axis Parameter List. | UINT#0 |
| VAR_OUTPUT | ||||
| B | Done | BOOL | Set high when the commanded action has completed successfully. If another block takes control before the action is completed, the Done output will not be set. This output is reset when Execute goes low. | |
| B | Busy | BOOL | Set high upon the rising edge of the Execute input, and reset when Done, CommandAborted, or Error is true. In the case of a function block with an Enable input, a Busy output indicates the function is operating, but not ready to provide Valid information. (No Error) | |
| B | Error | BOOL | Set high if an error has occurred during the execution of the function block. This output is cleared when 'Execute' or 'Enable' goes low. | |
| E | ErrorID | UINT | If Error is true, this output provides the Error ID. This output is reset when 'Execute' or 'Enable' goes low. | |
| V | Value | STRING | Value of the parameter. | |
Notes
Refer to parameters with STRING Data Type in the Axis Parameter List.
Error Description
See the
Function Block ErrorID List
Example
Reports the actual motor model string exactly as read from the servopack at power on. Parameter 1823Using Y_ReadStringParameter to read the ServoPack model.