Structures
AtnApiStatus_typ
Status type used for feedback for action calls.
| Name | Type | Description |
|---|---|---|
| active | BOOL | Action is active |
| busy | BOOL | Action in progress |
| done | BOOL | Action completed, this will stay true for 1 fn call |
| aborted | BOOL | Action aborted |
| error | BOOL | Action had an error |
| errorID | UDINT | ID of the error that occurred |
AtnAPI_typ
Module type used for registered actions.
| Name | Type | Description |
|---|---|---|
| moduleName | STRING[80] | Name of module, for debug |
| moduleStatus | STRING[80] | Description of current status of module, for debug |
| request | STRING | Name of action calling module |
| state | ATN_ST_enum | Current state of action |
| response | ATN_ST_enum | Response of module. When response is equal to state, module is done |
| subState | UDINT | Internal |
| subStateReq | UDINT | Internal |
| oneShot | BOOL | Internal |
| moduleBypass | BOOL | Sets module to be bypassed |
| moduleIsBypassed | BOOL | Feedback from director that module is being bypassed |
| activeThread | UDINT* | Internal |
| waitingThread | UDINT* | Internal |
| waitingDirectorID | USINT | Internal |
AtnPlcOpenStatus
Structure used to report the PLC Open status of a command being executed.
| Name | Type | Description |
|---|---|---|
| activeCommand | STRING | Name of the command being executed |
| status | DINT | PLC Open status in integer form |
| parametersWritten | BOOL | Indicator that parameters were written with this call |
| bypass | BOOL | Command to bypass |
| internal | AtnPlcOpenInternal | Internal structure |
AtnPlcOpenInternal
Internal structure used for processing PLC Open commands.
| Name | Type | Description |
|---|---|---|
| fbk | UDINT | Internal structure |
| trig | BOOL | Internal datatype |
ATN_ST_enum
States used by Modules and Actions.
| Name | Value | Description |
|---|---|---|
| ATN_IDLE | Action is idle and ready for next command | |
| ATN_EXECUTE | Action is being executed | |
| ATN_WAITING | Action is waiting | |
| ATN_DONE | Action is done | |
| ATN_ABORT | Action is being aborted | |
| ATN_ERROR | An error occurred | |
| ATN_BYPASSED | Action is being bypassed |
ATN_ERROR_enum
Status enum for ATN functions.
| Name | Value | Description |
|---|---|---|
| ATN_ERROR_OK | No error | |
| ATN_ERROR_ACTIVE | Active | |
| ATN_ERROR_ABORTED | Aborted | |
| ATN_ERROR_ACTIONS_FULL | Action list is full | |
| ATN_ERROR_BUSY | Busy |
ATN_RESPONSE_ST
Internal responses between Threads and Directors.
| Name | Value | Description |
|---|---|---|
| ATN_RESPONSE_ST_NONE | None | |
| ATN_RESPONSE_ST_ERROR | Error | |
| ATN_RESPONSE_ST_STEP_DONE | Step completed | |
| ATN_RESPONSE_ST_NEXT_STEP | Next step | |
| ATN_RESPONSE_ST_STATE_DONE | State completed | |
| ATN_RESPONSE_ST_BUSY | Busy |
Constants
Library constants.
| Name | Value | Description |
|---|---|---|
| ATN_ACTION_NAME_LEN | 20 | Max length of action names |