Y_GP_ReadPointFile
Y_GP_ReadPointFile is used within Pendant_Driver as a method to read a file containing teach points stored on the controller's flash memory.
Parameters
| * | Parameter | Data Type | Description | Default |
|---|---|---|---|---|
| VAR_IN_OUT | ||||
| V | UserAppData | Yt_GP_UserApplicationData |
Structure that will store the information of the Point List read from the file. |
|
| 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 | TeachPointList | Yt_String32 |
Name of the .TPL file to be read from the flash memory of the controller. |
'MyTeachPoints' |
| V | BufferSize | UDINT |
Specify the portion of the file to read during each task interval. |
UDINT#4096 |
| VAR_OUTPUT | ||||
| B | Done | BOOL | Indicates that the function is operating normally and the outputs of the function are valid. | |
| B | Busy | BOOL | Set high upon the rising edge of the Execute input, and reset when Done, 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 | ErrorRow | INT | If applicable, indicates the row in the file which generated the error. | |
| V | ErrorCol | INT | If applicable, indicates the column in the file which generated the error. | |
Notes
- UserAppData.PointList will be populated for each teach point's pertinent information from the file.
- The .TPL files are read from the following path in the controller /opt/plcnext/user/data, which is the available memory for user files (see more details in Memory area available for user files in ic92xx).
Error Description
See the Function Block ErrorID List.
Example
Reading the file 'PointFile.TPL' from the flash memory of the controller. Notice that the file extension nor the path of the file are given in the 'TeachPointList' input, just the file name. For writing files see Y_GP_WritePointFile
