|
1 | | -Tmp_Net_V1 |
| 1 | +## Table of Contents |
| 2 | +* [Introduction](#Introduction) |
| 3 | +* [Requirements](#Requirements) |
| 4 | +* [Description](#Description) |
| 5 | +* [Revision History](#Revision-History) |
| 6 | + |
| 7 | +<a name="Introduction"></a> |
| 8 | +## Introduction |
| 9 | +This is a sample project for mounting a network share on a B&R PLC. |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +Download the latest release from [**here.**](https://github.com/br-automation-com/AS-NET/releases) |
| 14 | + |
| 15 | +<a name="Description"></a> |
| 16 | +The task uses a variable structure to communicate with the outside world that can also be used to interact with other tasks. The structure* looks as follows: |
| 17 | + |
| 18 | +<table> |
| 19 | + <tr> |
| 20 | + <td width=100>Level 1</td> |
| 21 | + <td>Level 2</td> |
| 22 | + <td>Level Description</td> |
| 23 | + </tr> |
| 24 | + <tr style="font-weight:bold"> |
| 25 | + <th>CMD</th> |
| 26 | + <td colspan="3">Used to trigger commands.</td> |
| 27 | + </tr> |
| 28 | + <tr> |
| 29 | + <td></td> |
| 30 | + <td>error_reset</td> |
| 31 | + <td colspan="3">Reset pending erros</td> |
| 32 | + </tr> |
| 33 | + <th> PAR </th> |
| 34 | + <td colspan="3">Parameters tructure</td> |
| 35 | + </tr> |
| 36 | + <tr> |
| 37 | + <td></td> |
| 38 | + <td>state_machine</td> |
| 39 | + <td colspan="3">Shows the internal state of the task.</td> |
| 40 | + </tr> |
| 41 | + <tr> |
| 42 | + <td></td> |
| 43 | + <td>server_name</td> |
| 44 | + <td colspan="3">Name of the network share. Use this name or IP address</td> |
| 45 | + </tr> |
| 46 | + <tr> |
| 47 | + <td></td> |
| 48 | + <td>server_ip</td> |
| 49 | + <td colspan="3">IP address ofthe network share. Use IP address or network name.</td> |
| 50 | + </tr> |
| 51 | + <tr> |
| 52 | + <td></td> |
| 53 | + <td>server_port</td> |
| 54 | + <td colspan="3">Port on the network target. Leave empty to use default port.</td> |
| 55 | + </tr> |
| 56 | + <tr> |
| 57 | + <td></td> |
| 58 | + <td>server_protocol</td> |
| 59 | + <td colspan="3">Type of network connection. Use ftp, cifs, nfs or tftp.</td> |
| 60 | + </tr> |
| 61 | + <tr> |
| 62 | + <td></td> |
| 63 | + <td>server_domain</td> |
| 64 | + <td colspan="3">Domain name.</td> |
| 65 | + </tr> |
| 66 | + <tr> |
| 67 | + <td></td> |
| 68 | + <td>server_share</td> |
| 69 | + <td colspan="3">Name of the network share on the target.</td> |
| 70 | + </tr> |
| 71 | + <tr> |
| 72 | + <td></td> |
| 73 | + <td>user_name</td> |
| 74 | + <td colspan="3">User name.</td> |
| 75 | + </tr> |
| 76 | + <tr> |
| 77 | + <td></td> |
| 78 | + <td>user_password</td> |
| 79 | + <td colspan="3">User password.</td> |
| 80 | + </tr> |
| 81 | + <tr> |
| 82 | + <td></td> |
| 83 | + <td>enable_connect</td> |
| 84 | + <td colspan="3">Used to enable/disbale connect button in HMI.</td> |
| 85 | + </tr> |
| 86 | + <tr> |
| 87 | + <td></td> |
| 88 | + <td>can_ping</td> |
| 89 | + <td colspan="3">Indicates that the network share can be pinged.</td> |
| 90 | + </tr> |
| 91 | + <tr> |
| 92 | + <td></td> |
| 93 | + <td>is_linked</td> |
| 94 | + <td colspan="3">Indicates that the network share is linked.</td> |
| 95 | + </tr> |
| 96 | + <tr> |
| 97 | + <th> ERR </th> |
| 98 | + <td colspan="3">Information about errors</td> |
| 99 | + </tr> |
| 100 | + <tr> |
| 101 | + <td></td> |
| 102 | + <td>no</td> |
| 103 | + <td colspan="3">Error number</td> |
| 104 | + </tr> |
| 105 | + <tr> |
| 106 | + <td></td> |
| 107 | + <td>state</td> |
| 108 | + <td colspan="3">State where the error occurred</td> |
| 109 | + </tr> |
| 110 | + <tr> |
| 111 | + <td></td> |
| 112 | + <td>text</td> |
| 113 | + <td colspan="3">Error text</td> |
| 114 | + </tr> |
| 115 | + <tr> |
| 116 | + <td></td> |
| 117 | + <td>active</td> |
| 118 | + <td colspan="3">True when in error state</td> |
| 119 | + </tr> |
| 120 | +</table> |
| 121 | + |
| 122 | +<a name="Requirements"></a> |
| 123 | +## Requirements |
| 124 | +* Automation Studio 4.5 |
| 125 | +* Automation Runtime D4.52 |
| 126 | + |
| 127 | +Recommended task class is #8 with a 10ms cycle time. |
| 128 | + |
| 129 | +<a name="Revision-History"></a> |
| 130 | +## Revision History |
| 131 | + |
| 132 | +#### Version 0.2 |
| 133 | +- Added ping support |
| 134 | + |
| 135 | +#### Version 0.1 |
| 136 | +- Initial commit |
0 commit comments