├── .gitignore ├── HMI_Project ├── Ignition-HMI Project-backup-20200918-2132.gwbk └── Readme ├── Ignition-HMI Project-backup-20200918-2132.gwbk ├── LICENSE ├── README.md ├── Simulation diagram.png ├── v01 ├── ICSUnitSim.ino └── blank └── v02 ├── ICSUnitSim.ino └── img ├── ICSUnitSimP&IDv02.png ├── ICSonChip.gif └── img.gif /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Compiled Object files 5 | *.slo 6 | *.lo 7 | *.o 8 | *.obj 9 | 10 | # Precompiled Headers 11 | *.gch 12 | *.pch 13 | 14 | # Compiled Dynamic libraries 15 | *.so 16 | *.dylib 17 | *.dll 18 | 19 | # Fortran module files 20 | *.mod 21 | *.smod 22 | 23 | # Compiled Static libraries 24 | *.lai 25 | *.la 26 | *.a 27 | *.lib 28 | 29 | # Executables 30 | *.exe 31 | *.out 32 | *.app 33 | -------------------------------------------------------------------------------- /HMI_Project/Ignition-HMI Project-backup-20200918-2132.gwbk: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/akiUp/ICSUnitSim/dd845992a4c21b3cfdf715c544987988f8faeae1/HMI_Project/Ignition-HMI Project-backup-20200918-2132.gwbk -------------------------------------------------------------------------------- /HMI_Project/Readme: -------------------------------------------------------------------------------- 1 | Placeholder for HMI projects, to visualise Modbus simulation output. 2 | -------------------------------------------------------------------------------- /Ignition-HMI Project-backup-20200918-2132.gwbk: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/akiUp/ICSUnitSim/dd845992a4c21b3cfdf715c544987988f8faeae1/Ignition-HMI Project-backup-20200918-2132.gwbk -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ICSUnitSim on ESP32 board *("ICS on Chip")* 2 | 3 | > Realtime Process Simulation of Plant Water Supply Unit 4 | 5 | > Simulation Generates logically correct Modbus signals of Water Supply facility using ESP32 MCU board with ModbusTCP interface 6 | 7 | > Simulation intended for HMI and DCS testing with realtime values and for ICS security research 8 | 9 | > Developed using Arduino IDE for ESP32 (ESP 32 MCU board is available on Aliexpress for approx price of 5$) 10 | 11 | ## Version history 12 | - Added HMI project backup for output visualisation 13 | - V0.2 Introduced Pump AUTO functionality, adjustable setpoints, tank_drain variable on modbus 14 | - V0.1 Initial code with manual controls only 15 | 16 | ## Table of Contents 17 | 18 | - [HMI Example](#HMI) 19 | - [Simulation setup](#Simulation) 20 | - [Virtual process P&ID](#Virtual) 21 | - [Modbus addressing](#Modbus) 22 | - [Follow](#Follow) 23 | - [Credits](#Credits) 24 | - [Version history](#Version) 25 | 26 | ## HMI Visualisation Example 27 | HMI_Project folder contains latest backup of Ignition HMI Project, restore it to you Ignition setup for below result. 28 | 29 | HMI Demo 30 | 31 | Current HMI Example is designed on Ignition SCADA by Inductive Automation 32 | 33 | Free trial versions of HMI software like RapidSCADA, Ignition and Advantech is available on internet. 34 | 35 | For simple Modbus values reading/writing you could use RMMS tool http://en.radzio.dxp.pl/modbus-master-simulator/ 36 | 37 | ## Simulation Setup 38 | 39 | Connection diagram 40 | 41 | ## Virtual process's P&ID 42 | 43 | Simulation P&ID 44 | 45 | ## Modbus addressing 46 | 47 | > !Important!: Modbus library uses 0 based adressing 48 | 49 | - ***Modbus Coils Offsets (read\write)*** 50 | ```shell 51 | mot_start, address: 100, boolean, Start button, 1 to activate, returns to 0 after activation 52 | 53 | mot_stop, address: 110, boolean, Stop button, 1 to activate, returns to 0 after activation 54 | 55 | valve_state, address: 120, boolean 0-Closed 1-Open (Controlled by start/stop logic) 56 | 57 | mat_auto, address:130, boolean, 1-Pump automatic mode(by setpoints), 0 - manual mode 58 | ``` 59 | - ***Modbus input status (Discrete Inputs) Offsets(read only)*** 60 | ```shell 61 | mot_run, address: 100, boolean, 1 running, 0 stop 62 | mot_trip, address: 110, boolean, Motor trip state, cause: Tank full, Valve closed, Random trip (1 of 10000) 63 | ``` 64 | - ***Modbus Input Register Offsets (read only)*** 65 | ```shell 66 | mot_load, address: 100; Uint16, range:0-100, random motor load simulation 67 | 68 | flowm_flow, address: 110, Uint16, range:0-10, flow value depending on mot_load 69 | 70 | tank_level, address: 120, Uint16, range:0-65000, 65000 value trips the motor, has constant (random of 4) drainage flow 71 | 72 | tank_drain, address: 130; Uint16, Random drain by process 73 | ``` 74 | - ***Modbus Holding Register Offsets (read\write)*** 75 | ```shell 76 | tank_Hi, address: 100; Uint16, adjustable Hi level setpoint, for turning motor OFF in AUTO mode 77 | 78 | tank_Lo, address: 110; Uint16, adjustable Lo level setpoint, for turning motor ON in AUTO mode 79 | ``` 80 | 81 | ## Follow 82 | Follow author on twitter for project updates 83 | https://twitter.com/supeyev/ 84 | 85 | ## Credits 86 | - Based on Alexander Emelianov (a.m.emelianov@gmail.com) Modbus library 87 | https://github.com/emelianov/modbus-esp8266 @emelianov 88 | - Inductive Automation's Ignition SCADA used for HMI Design https://inductiveautomation.com/ignition/ 89 | 90 | 91 | -------------------------------------------------------------------------------- /Simulation diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/akiUp/ICSUnitSim/dd845992a4c21b3cfdf715c544987988f8faeae1/Simulation diagram.png -------------------------------------------------------------------------------- /v01/ICSUnitSim.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Interactive ICS process simulation with ModbusTCP 3 | By Zakir Supeyev 2020 zakir.supeyev@gmail.com 4 | 5 | https://github.com/akiUp/ICSUnitSim 6 | 7 | //-----Modbus Coils Offsets (read\write) 8 | mot_start, address: 100, boolean, Start button, 1 to activate, returns to 0 after activation 9 | mot_stop, address: 110, boolean, Stop button, 1 to activate, returns to 0 after activation 10 | valve_state, address: 120, boolean 0-Closed 1-Open (Controlled by start/stop logic) 11 | //-----Modbus input status (Discrete Inputs) Offsets(read only) 12 | mot_run, address: 100, boolean, 1 running, 0 stop 13 | mot_trip, address: 110, boolean, Motor trip state, cause: Tank full, Valve closed, Random trip (1 of 10000) 14 | //-----Modbus Input Register Offsets (read only) 15 | mot_load, address: 100; Uint16, range:0-100, random motor load simulation 16 | flowm_flow, address: 110, Uint16, range:0-10, flow value depending on mot_load 17 | tank_level, address: 120, Uint16, range:0-65000, 65000 value trips the motor, has constant (random of 4) drainage flow 18 | 19 | Based on Alexander Emelianov (a.m.emelianov@gmail.com) Modbus library 20 | https://github.com/emelianov/modbus-esp8266 21 | */ 22 | #define Debug //Comment this field if debug output via serial is not required 23 | #ifdef ESP8266 24 | #include 25 | #else //ESP32 26 | #include 27 | #endif 28 | #include 29 | 30 | //Wifi Variables 31 | const char *ssid = "YourSSIDHere"; 32 | const char *password = "YourPSKHere"; 33 | 34 | // -----Process variables 35 | //Motor variables 36 | 37 | int mot_load =0; //load of the motor 38 | bool mot_trip = false; //motor tripping state variable 39 | bool mot_run = false; //motor "RUN" state variable 40 | int mot_randerr =0; //motor random error 41 | 42 | //Flow meter variable 43 | int flowm_flow =0; 44 | int flowm_max =4; //Maximum flow 45 | //Tank level variable 46 | int tank_level = 0; //Tank level 0=empty 47 | const int tank_HH = 65000; //tank maximum capacity (HiHi alarm) 48 | 49 | 50 | //-----Modbus Coils Offsets (read\write) 51 | const int mot_start_C = 100; 52 | const int mot_stop_C = 110; 53 | const int valve_state_C = 120; 54 | //-----Modbus input status (Discrete Inputs) Offsets(read only) 55 | const int mot_run_IS = 100; 56 | const int mot_trip_IS = 110; 57 | //-----Modbus Input Register Offsets (read only) 58 | const int mot_load_IR = 100; 59 | const int flowm_flow_IR = 110; 60 | const int tank_level_IR = 120; 61 | 62 | //Used Pins 63 | const int runPin = 2; //Used to signal RUN state 64 | 65 | //ModbusIP object 66 | ModbusIP modbus; 67 | 68 | void setup() { 69 | #ifdef ESP8266 70 | Serial.begin(74880); 71 | #else 72 | Serial.begin(115200); 73 | #endif 74 | 75 | WiFi.begin(ssid, password); 76 | 77 | while (WiFi.status() != WL_CONNECTED) { 78 | delay(500); 79 | Serial.print("."); 80 | } 81 | 82 | Serial.println(""); 83 | Serial.println("WiFi connected"); 84 | Serial.println("IP address: "); 85 | Serial.println(WiFi.localIP()); 86 | 87 | modbus.slave(); 88 | 89 | pinMode(runPin, OUTPUT); 90 | //Define coils 91 | modbus.addCoil(mot_start_C, false); 92 | modbus.addCoil(mot_stop_C, false); 93 | modbus.addCoil(valve_state_C, false); 94 | //define Discrete Inputs 95 | modbus.addIsts(mot_run_IS, false); 96 | modbus.addIsts(mot_trip_IS, false); 97 | //Define Input registers 98 | modbus.addIreg(mot_load_IR, 0); 99 | modbus.addIreg(flowm_flow_IR, 0); 100 | modbus.addIreg(tank_level_IR, 0); 101 | } 102 | 103 | void loop() { 104 | //Call once inside loop() - modbus engine 105 | modbus.task(); 106 | 107 | if (mot_run==true) //-----checking running state and running process if true 108 | { 109 | digitalWrite(runPin, mot_run); //turn RUN led on 110 | modbus.Coil(mot_start_C, false); //reset start signal to 0 111 | mot_randerr = random (10000); // random error function for motor 112 | mot_load = 60+random (4)*10; // simulate random motor load 113 | flowm_flow = mot_load/10; // simulate flow dependency on motor load 114 | tank_level = tank_level+flowm_flow; //simulate tank filling dependency from flow 115 | 116 | if (mot_randerr == 10000) //motor random trip condition 117 | { 118 | #ifdef Debug 119 | Serial.println ("Random trip!"); 120 | #endif 121 | flowm_flow = 0; //no flow due to motor trip 122 | mot_load= 0; //no load due to motor trip 123 | mot_run = 0; //Reset RUN condition 124 | mot_trip = true; //motor trip bit on 125 | modbus.Coil(valve_state_C, false);//fail-close valve simulation 126 | digitalWrite(runPin, mot_run); //turn RUN led off 127 | } 128 | 129 | if (modbus.Coil(valve_state_C) == false) //tripping motor on valve state 130 | { 131 | #ifdef Debug 132 | Serial.println ("Valve trip!"); 133 | #endif 134 | flowm_flow = 0; //no flow due to motor trip 135 | mot_load= 0; //no load due to motor trip 136 | mot_run = 0; //Reset RUN condition 137 | mot_trip = true; //motor trip bit on 138 | modbus.Coil(valve_state_C, false);//fail-close valve simulation 139 | digitalWrite(runPin, mot_run); //turn RUN led off 140 | } 141 | 142 | if (tank_level>tank_HH) //tripping on full condition(HiHi trip) 143 | { 144 | #ifdef Debug 145 | Serial.println ("Tank full trip!"); 146 | #endif 147 | flowm_flow = 0; //no flow due to motor trip 148 | mot_load= 0; //no load due to motor trip 149 | mot_run = 0; //Reset RUN condition 150 | mot_trip = true; //motor trip bit on 151 | digitalWrite(runPin, mot_run); //turn RUN led off 152 | } 153 | 154 | if (modbus.Coil(mot_stop_C)==true) //-----Stop signal routine 155 | { 156 | mot_run = !(modbus.Coil(mot_stop_C)); //stopping motor 157 | digitalWrite(runPin, mot_run); //turn RUN led off 158 | flowm_flow = 0; //no flow due to motor stop 159 | mot_load= 0; //no load due to motor stop 160 | modbus.Coil(valve_state_C, false);//automated valve closing routine 161 | modbus.Coil(mot_stop_C, false); //reset stop signal to 0 162 | } 163 | 164 | } 165 | else //wrapper in case of motor not running 166 | { 167 | if (modbus.Coil(mot_start_C) == true) //motor starting routine 168 | { 169 | modbus.Coil(mot_stop_C, false); //reset stop signal to 0 if set to avoid failstart 170 | mot_run = modbus.Coil(mot_start_C); //assign start coil status to RUN state 171 | digitalWrite(runPin, mot_run); //turn RUN led on 172 | mot_trip = false; //reset error bit in case of error shutdown 173 | modbus.Coil(valve_state_C, true); //trigger opening valve 174 | modbus.Ists(mot_run_IS, mot_run);//update RUN status coil 175 | } 176 | } 177 | 178 | //placehodler for tank drain logic 179 | if (tank_level>6) tank_level=tank_level-random(6); //constant random drain if tank is not empty; 180 | //assign read-only registers and inputs per iteration 181 | modbus.Ists(mot_trip_IS, mot_trip); 182 | modbus.Ists(mot_run_IS, mot_run); 183 | modbus.Ireg(mot_load_IR, mot_load); 184 | modbus.Ireg(flowm_flow_IR, flowm_flow); 185 | modbus.Ireg(tank_level_IR, tank_level); 186 | #ifdef Debug //Debug output to serial interface 187 | Serial.print ("Motor RUN: "); 188 | Serial.print (modbus.Ists(mot_run_IS)); 189 | Serial.print (" Motor trip: "); 190 | Serial.print (modbus.Ists(mot_trip_IS)); 191 | Serial.print (" Valve: "); 192 | Serial.print (modbus.Coil(valve_state_C)); 193 | Serial.print (" Flow: "); 194 | Serial.print (modbus.Ireg(flowm_flow_IR)); 195 | Serial.print (" Load: "); 196 | Serial.print (modbus.Ireg(mot_load_IR)); 197 | Serial.print (" Tank: "); 198 | Serial.print (modbus.Ireg(tank_level_IR)); 199 | Serial.print (" random Trip value: "); 200 | Serial.println (mot_randerr); 201 | #endif 202 | 203 | delay(100); 204 | } 205 | -------------------------------------------------------------------------------- /v01/blank: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /v02/ICSUnitSim.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Interactive ICS process simulation with ModbusTCP 3 | By Zakir Supeyev 2020 zakir.supeyev@gmail.com 4 | 5 | https://github.com/akiUp/ICSUnitSim 6 | 7 | //-----Modbus Coils Offsets (read\write) 8 | mot_start, address: 100, boolean, Start button, 1 to activate, returns to 0 after activation 9 | mot_stop, address: 110, boolean, Stop button, 1 to activate, returns to 0 after activation 10 | valve_state, address: 120, boolean 0-Closed 1-Open (Controlled by start/stop logic) 11 | mat_auto, address:130, boolean, 1-Pump automatic mode(by setpoints), 0 - manual mode 12 | //-----Modbus input status (Discrete Inputs) Offsets(read only) 13 | mot_run, address: 100, boolean, 1 running, 0 stop 14 | mot_trip, address: 110, boolean, Motor trip state, cause: Tank full, Valve closed, Random trip (1 of 10000) 15 | //-----Modbus Input Register Offsets (read only) 16 | mot_load, address: 100; Uint16, range:0-100, random motor load simulation 17 | flowm_flow, address: 110, Uint16, range:0-10, flow value depending on mot_load 18 | tank_level, address: 120, Uint16, range:0-65500, 65000 value trips the motor, has constant (random of 4) drainage flow 19 | tank_drain, address: 130; Uint16, Random drain by process 20 | //-----Modbus Holding Register Offsets (read\write) 21 | tank_Hi, address: 100; Uint16, adjustable Hi level setpoint, for turning motor OFF in AUTO mode 22 | tank_Lo, address: 110; Uint16, adjustable Lo level setpoint, for turning motor ON in AUTO mode 23 | 24 | Based on Alexander Emelianov (a.m.emelianov@gmail.com) Modbus library 25 | https://github.com/emelianov/modbus-esp8266 26 | */ 27 | #define Debug //Comment this field if debug output via serial is not required 28 | #ifdef ESP8266 29 | #include 30 | #else //ESP32 31 | #include 32 | #endif 33 | #include 34 | 35 | //Wifi Variables 36 | const char *ssid = "YourSSID"; 37 | const char *password = "YourPassword"; 38 | 39 | // -----Process variables 40 | //Motor variables 41 | 42 | int mot_load =0; //load of the motor 43 | bool mot_trip = false; //motor tripping state variable 44 | bool mot_run = false; //motor "RUN" state variable 45 | bool mot_auto = false; //Auto-Manual mode toggle 46 | int mot_randerr =0; //motor random error 47 | 48 | //Flow meter variable 49 | int flowm_flow =0; 50 | 51 | //Tank level variable 52 | int tank_level = 0; //Tank level 0=empty 53 | int tank_drain = 0; 54 | const int tank_HH = 65500; //tank maximum capacity (HiHi alarm) 55 | int tank_Hi = 58500; //Motor stop Setpoint capacity (Hi alarm) 56 | int tank_Lo = 10000; //Motor start Setpoint capacity (Hi alarm) 57 | 58 | //-----Modbus Coils Offsets (read\write) 59 | const int mot_start_C = 100; 60 | const int mot_stop_C = 110; 61 | const int valve_state_C = 120; //intentionally making it externally writable for security testing purpoces 62 | const int mot_auto_C = 130; 63 | //-----Modbus input status (Discrete Inputs) Offsets(read only) 64 | const int mot_run_IS = 100; 65 | const int mot_trip_IS = 110; 66 | 67 | //-----Modbus Input Register Offsets (read only) 68 | const int mot_load_IR = 100; 69 | const int flowm_flow_IR = 110; 70 | const int tank_level_IR = 120; 71 | const int tank_drain_IR = 130; 72 | 73 | //-----Modbus Holding Register Offsets (read\write) 74 | const int tank_Hi_HR = 100; 75 | const int tank_Lo_HR = 110; 76 | 77 | //Used Board Pins 78 | const int runPin = 2; //pin LED to signal RUN state 79 | 80 | //ModbusIP object 81 | ModbusIP modbus; 82 | 83 | void setup() { 84 | #ifdef ESP8266 85 | Serial.begin(74880); 86 | #else 87 | Serial.begin(115200); 88 | #endif 89 | 90 | WiFi.begin(ssid, password); 91 | 92 | while (WiFi.status() != WL_CONNECTED) { 93 | delay(500); 94 | Serial.print("."); 95 | } 96 | 97 | Serial.println(""); 98 | Serial.println("WiFi connected"); 99 | Serial.println("IP address: "); 100 | Serial.println(WiFi.localIP()); 101 | 102 | modbus.slave(); 103 | 104 | pinMode(runPin, OUTPUT); 105 | //Define coils 106 | modbus.addCoil(mot_start_C, false); 107 | modbus.addCoil(mot_stop_C, false); 108 | modbus.addCoil(valve_state_C, false); 109 | modbus.addCoil (mot_auto_C, mot_auto); 110 | //define Discrete Inputs 111 | modbus.addIsts(mot_run_IS, false); 112 | modbus.addIsts(mot_trip_IS, false); 113 | //Define Input registers 114 | modbus.addIreg(mot_load_IR, 0); 115 | modbus.addIreg(flowm_flow_IR, 0); 116 | modbus.addIreg(tank_level_IR, 0); 117 | modbus.addIreg(tank_drain_IR, 0); 118 | //Define Holding registers 119 | modbus.addHreg(tank_Hi_HR, tank_Hi); 120 | modbus.addHreg(tank_Lo_HR, tank_Lo); 121 | 122 | } 123 | 124 | void loop() { 125 | //Call once inside loop() - modbus engine 126 | modbus.task(); 127 | 128 | if (mot_run==true) //-----checking running state and running process if true 129 | { 130 | digitalWrite(runPin, mot_run); //turn RUN led on 131 | modbus.Coil(mot_start_C, false); //reset start signal to 0 132 | mot_randerr = random (10000); // random error function for motor 133 | mot_load = 60+random (4)*10; // simulate random motor load 134 | flowm_flow = mot_load/10; // simulate flow dependency on motor load 135 | tank_level = tank_level+flowm_flow; //simulate tank filling dependency from flow 136 | 137 | if (mot_randerr == 10000) //motor random trip condition 138 | { 139 | #ifdef Debug 140 | Serial.println ("Random trip!"); 141 | #endif 142 | flowm_flow = 0; //no flow due to motor trip 143 | mot_load= 0; //no load due to motor trip 144 | mot_run = 0; //Reset RUN condition 145 | mot_trip = true; //motor trip bit on 146 | modbus.Coil(valve_state_C, false);//fail-close valve simulation 147 | digitalWrite(runPin, mot_run); //turn RUN led off 148 | } 149 | 150 | if (modbus.Coil(valve_state_C) == false) //tripping motor on valve state 151 | { 152 | #ifdef Debug 153 | Serial.println ("Valve trip!"); 154 | #endif 155 | flowm_flow = 0; //no flow due to motor trip 156 | mot_load= 0; //no load due to motor trip 157 | mot_run = 0; //Reset RUN condition 158 | mot_trip = true; //motor trip bit on 159 | modbus.Coil(valve_state_C, false);//fail-close valve simulation 160 | digitalWrite(runPin, mot_run); //turn RUN led off 161 | } 162 | 163 | if (tank_level>tank_HH) //tripping on full condition(HiHi trip) 164 | { 165 | #ifdef Debug 166 | Serial.println ("Tank overflow trip!"); 167 | #endif 168 | flowm_flow = 0; //no flow due to motor trip 169 | mot_load= 0; //no load due to motor trip 170 | mot_run = 0; //Reset RUN condition 171 | mot_trip = true; //motor trip bit on 172 | modbus.Coil(valve_state_C, false);//fail-close valve simulation 173 | digitalWrite(runPin, mot_run); //turn RUN led off 174 | } 175 | 176 | if (modbus.Coil(mot_stop_C)==true) //-----Stop signal routine 177 | { 178 | #ifdef Debug 179 | Serial.println ("Stop command recieved"); 180 | #endif 181 | mot_run = !(modbus.Coil(mot_stop_C)); //stopping motor 182 | digitalWrite(runPin, mot_run); //turn RUN led off 183 | flowm_flow = 0; //no flow due to motor stop 184 | mot_load= 0; //no load due to motor stop 185 | modbus.Coil(valve_state_C, false);//automated valve closing routine 186 | modbus.Coil(mot_stop_C, false); //reset stop signal to 0 187 | } 188 | 189 | if (modbus.Coil(mot_auto_C) == true && tank_level >= modbus.Hreg(tank_Hi_HR)) //-----Stop signal routine 190 | { 191 | #ifdef Debug 192 | Serial.println ("Stopping on Hi setpoint"); 193 | #endif 194 | mot_run = false; //stopping motor 195 | digitalWrite(runPin, mot_run); //turn RUN led off 196 | flowm_flow = 0; //no flow due to motor stop 197 | mot_load= 0; //no load due to motor stop 198 | modbus.Coil(valve_state_C, false);//automated valve closing routine 199 | modbus.Coil(mot_stop_C, false); //reset stop signal to 0 200 | } 201 | 202 | } 203 | else //wrapper in case of motor not running 204 | { 205 | if (modbus.Coil(mot_start_C) == true) //motor starting routine 206 | { 207 | #ifdef Debug 208 | Serial.println ("Starting motor by command"); 209 | #endif 210 | modbus.Coil(mot_stop_C, false); //reset stop signal to 0 if set to avoid failstart 211 | mot_run = modbus.Coil(mot_start_C); //assign start coil status to RUN state 212 | digitalWrite(runPin, mot_run); //turn RUN led on 213 | mot_trip = false; //reset error bit in case of error shutdown 214 | modbus.Coil(valve_state_C, true); //trigger opening valve 215 | modbus.Ists(mot_run_IS, mot_run);//update RUN status coil 216 | } 217 | if (modbus.Coil(mot_auto_C) == true && tank_level <= modbus.Hreg(tank_Lo_HR)) //Automatic motor starting on Tank Lo signal routine 218 | {if (mot_trip == false) 219 | { //check that motor not tripped 220 | #ifdef Debug 221 | Serial.println ("Starting motor by Lo setpoint"); 222 | #endif 223 | mot_run = true; //assign start coil status to RUN state 224 | digitalWrite(runPin, mot_run); //turn RUN led on 225 | modbus.Coil(valve_state_C, true); //trigger opening valve 226 | modbus.Ists(mot_run_IS, mot_run);//update RUN status coil 227 | } 228 | } 229 | } 230 | //placehodler for emergency shutdown logic 231 | if (modbus.Coil(mot_stop_C)==true) //-----Stop signal routine 232 | { 233 | mot_run = false; //stopping motor 234 | modbus.Coil(mot_auto, false); //reset operation to manual 235 | mot_trip = false; //reset trip status 236 | modbus.Coil(mot_stop_C, false); //reset stop signal to 0 237 | } 238 | 239 | //placehodler for tank drain logic 240 | if (tank_level>6) 241 | { 242 | tank_level=tank_level-tank_drain; //constant random drain if tank is not empty; 243 | tank_drain = random(6); 244 | } 245 | //assign read-only registers and inputs per iteration 246 | modbus.Ists(mot_trip_IS, mot_trip); 247 | modbus.Ists(mot_run_IS, mot_run); 248 | modbus.Ireg(mot_load_IR, mot_load); 249 | modbus.Ireg(flowm_flow_IR, flowm_flow); 250 | modbus.Ireg(tank_level_IR, tank_level); 251 | modbus.Ireg(tank_drain_IR, tank_drain); 252 | 253 | #ifdef Debug //Debug output to serial interface 254 | Serial.print ("Motor RUN: "); 255 | Serial.print (modbus.Ists(mot_run_IS)); 256 | Serial.print (" Motor trip: "); 257 | Serial.print (modbus.Ists(mot_trip_IS)); 258 | Serial.print (" Valve: "); 259 | Serial.print (modbus.Coil(valve_state_C)); 260 | Serial.print (" Flow: "); 261 | Serial.print (modbus.Ireg(flowm_flow_IR)); 262 | Serial.print (" Load: "); 263 | Serial.print (modbus.Ireg(mot_load_IR)); 264 | Serial.print (" Tank: "); 265 | Serial.print (modbus.Ireg(tank_level_IR)); 266 | Serial.print (" Hi Setpoint: "); 267 | Serial.print (modbus.Hreg(tank_Hi_HR)); 268 | Serial.print (" Lo Setpoint: "); 269 | Serial.print (modbus.Hreg(tank_Lo_HR)); 270 | Serial.print (" random Trip value: "); 271 | Serial.println (mot_randerr); 272 | #endif 273 | 274 | delay(10); 275 | } 276 | -------------------------------------------------------------------------------- /v02/img/ICSUnitSimP&IDv02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/akiUp/ICSUnitSim/dd845992a4c21b3cfdf715c544987988f8faeae1/v02/img/ICSUnitSimP&IDv02.png -------------------------------------------------------------------------------- /v02/img/ICSonChip.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/akiUp/ICSUnitSim/dd845992a4c21b3cfdf715c544987988f8faeae1/v02/img/ICSonChip.gif -------------------------------------------------------------------------------- /v02/img/img.gif: -------------------------------------------------------------------------------- 1 | 2 | --------------------------------------------------------------------------------