├── README.md
└── LICENSE
/README.md:
--------------------------------------------------------------------------------
1 | # TwinCAT Resources
2 |
3 | A curated list of TwinCAT resources.
4 |
5 | ## Contributing
6 | If you have a link which is worth sharing with others, please raise a new issue on the issues tab, or submit it to the repo by creating a pull request.
7 |
8 | >[!TIP]
9 | >Not sure where a link belongs? Just share the link using an issue and I'll sort it out for you.
10 |
11 | ## Contents
12 |
13 | * General - Broad resources covering TwinCAT, Beckhoff, and interesting automation topics.
14 | * [Beckhoff](#beckhoff)
15 | * [Blogs](#blogs)
16 | * [Forums](#forums)
17 | * [Libraries](#libraries)
18 | * [Repos](#repos)
19 | * [Videos](#videos)
20 | * [Other](#other)
21 |
22 | * Topic-specific - Resources tied to a specific TwinCAT feature, module or 3rd party.
23 | * [Modules & Features](#modules--features)
24 | * [3rd Party Integration](#3rd-party-integration)
25 |
26 | ## Beckhoff
27 |
28 | *Official Beckhoff pages*
29 |
30 | * [Beckhoff](https://beckhoff.com/) - Main website
31 | * [Beckhoff Github](https://github.com/Beckhoff/) - Main Github page
32 | * [Infosys](https://infosys.beckhoff.com/english.php?content=../content/1033/tcinfosys3/index.html) - Main resource for datasheets, information and example code.
33 | * [TCBSD Packages](https://tcbsd.beckhoff.com/) - Package directory for TwinCAT/BSD
34 |
35 | ## Blogs
36 |
37 | *TwinCAT related blogs*
38 |
39 | * [AllTwinCAT](https://alltwincat.com/) by **Jakob Sagatowski** - The TwinCAT development blog
40 | * [Automacaoweb](https://automacaoweb.wordpress.com/) [\[translated\]](https://automacaoweb-wordpress-com.translate.goog/?_x_tr_sl=pt&_x_tr_tl=en&_x_tr_hl=en-GB) by **Automacaoweb** - A large collection of TwinCAT examples and walkthroughs (Portuguese)
41 | * [Automate to live](https://hopperpop.github.io/) by **Bram Gurdebeke** - A blog about automation and TwinCAT.
42 | * [Chris Chung's PLC Blog](http://soup01.com/en/) by **Chris Chung** - An active blog on TwinCAT, TwinCAT Vision, and Robotics. This is a must read! Chris does an exceptional job exploring new and existing technology.
43 | * [Contact and Coil](http://www.contactandcoil.com/) by **Scott Whitlock** - Programming tutorials on TwinCAT 3
44 | * [Cook & Code](https://roald87.github.io/twincat) by **Roald Ruiter** - TwinCAT blog by the author of [TcBlack](https://github.com/Roald87/TcBlack)
45 | * [ekvip Blog](https://ekvip.de/blog-ekvip/) by **ekvip automation GmbH** - A blog exploring the world of PLC programming, TwinCAT, and automation, offering insights, knowledge, and a comprehensive [style guide](https://ekvip.de/style-guide/) for professionals and newcomers alike.
46 | * [Got TwinCAT](https://gotwincat.blogspot.com/) [\[translated\]](https://gotwincat-blogspot-com.translate.goog/?_x_tr_sl=ru&_x_tr_tl=en&_x_tr_hl=en-GB) by **Voronin Nikolai** (Russian)
47 | * [Kassym Dorsel’s Blog](https://kassymdorsel.com/blog) by **Kassym** TwinCAT 3 development blog
48 | * [PLC Coder](https://www.plccoder.com/) by **Gerhard Barteling** - TwinCAT development blog from the author of [STweep](https://www.stweep.com/)
49 | * [Stefan Henneken](https://stefanhenneken.net/) by **Stefan Henneken** - Posts covering TwinCAT, Object oriented programming, .Net and C#
50 |
51 | ## Forums
52 |
53 | *TwinCAT related forums*
54 | * [SPS-Forum](https://www.sps-forum.de/forums/sonstige-steuerungen.11/) [\[translated\]](https://www-sps--forum-de.translate.goog/forums/sonstige-steuerungen.11/?_x_tr_sl=de&_x_tr_tl=en&_x_tr_hl=en-GB) - Big German PLC forum, many discussions about TwinCAT 2/3 (German)
55 | * [TwinCAT LinkedIn forum](https://www.linkedin.com/groups/1860933) - A friendly group of TwinCAT developers
56 | * [twinControls](https://www.twincontrols.com/community/) - An unofficial "Beckhoff Community" forum
57 | * [SASE: Society of Automation Software Engineers](https://sase.space/) - A Slack group and professional networking society for automation software engineering, with a large Beckhoff contingent
58 |
59 | ## Libraries
60 |
61 | * [Fisothemes TwinCAT Libraries](https://github.com/fisothemes/) A collection of TwinCAT Libraries, such as [Dynamic Collections](https://github.com/fisothemes/TwinCat-Dynamic-Collections), [Hashing Algorithms](https://github.com/fisothemes/TwinCAT-Hashing-Algorithms)
62 | * [IntecreLibs library](https://github.com/Intecre/twincat-utils) Open source library with utility functions for TwinCAT developed by **Mark Lazarides**.
63 | * [mobject](http://mobject.org) Growing open source library based on OOP principles for machine builders.
64 | * [OSCAT libraries](http://www.oscat.de/) OSCAT has developed a comprehensive standard library for the IEC61131-3 language
65 | * [Struckig](https://github.com/stefanbesler/struckig) Open source library for online, time-optimal, jerk-constrained trajectory-generation for multiple degree-of-freedoms.
66 | * [Twingrind](https://github.com/stefanbesler/twingrind) Open source call-graph profiling for TwinCAT 3
67 | * [TwinSharp](https://github.com/kimblad/TwinSharp) - A C# library that can view and control many aspects of TwinCAT such as: axes, PLCs, realtime settings and IPC.
68 | * [Stage](https://github.com/Krystian-L-Lis/Stage) – Framework for building PLC applications with a browsable composition model, state model, MPMC channel, and other useful tools.
69 |
70 | ## Repos
71 |
72 | *TwinCAT related repos and github groups*
73 |
74 | * [Beckhoff USA Community Repo](https://github.com/Beckhoff-USA-Community) - A community collection of samples, examples, and libraries like the [SPT-Libraries](https://github.com/Beckhoff-USA-Community/SPT-Libraries)
75 | * [Jack Borelius' Github](https://github.com/hijaaack?tab=repositories) - A comprehensive collection of Open-source framework controls for TwinCAT HMI
76 | * [log4TC](https://github.com/mbc-engineering/log4TC) - Open source logger for TwinCAT. Documentation found [here](https://mbc-engineering.github.io/log4TC/index.html).
77 | * [Non-official TwinCAT changelog](https://github.com/Roald87/TwinCatChangelog) - This repo is a community effort which tries to track changes in Beckhoff's TwinCAT software
78 | * [PLC Sphinx Parser](https://github.com/DEMCON/plcdoc) - Sphinx Parser for automated code documentation
79 | * [Stefanbesler](https://github.com/stefanbesler) - Collection of TwinCAT repos, including a simple and lightweight JSON decoder.
80 | * [TcLibraryVersions](https://github.com/RumstiBumsti/TcLibraryVersions) - A list of all TwinCAT libraries and which libraries are included in the different versions of TwinCAT
81 | * [TcLog](https://github.com/bengeisler/TcLog) - Open source logger for TwinCAT. Blog found [here](https://www.benediktgeisler.de/en/blog/).
82 | * [TcOpenGroup](https://github.com/TcOpenGroup) - Open source libraries and tools for Beckhoffs' TwinCAT3 platform
83 | * [TcUnit](https://github.com/TcUnit) - An unit testing framework for Beckhoff's TwinCAT 3
84 | * [Twinpack](https://github.com/Zeugwerk/Twinpack) - A powerful and user-friendly package management tool for TwinCAT libraries.
85 |
86 | ## Videos
87 |
88 | *TwinCAT video tutorials and YouTube channels worth seeing*
89 |
90 | * [Beckhoff DE - Tutorials](https://www.beckhoff.com/en-us/support/tutorials/) - Official detailed tutorials by Beckhoff PMs and Industry Specialists for short in-depth insight into Beckhoff products
91 | * [Beckhoff AU - Teachable](https://beckhoff-au.teachable.com/) - Contains free training videos
92 | * [Beckhoff Italy Tutorials](https://www.gotostage.com/channel/c59deb70de3e4b9e975a175fb91e6109) - A large collection of tutorials from the team in Italy (Italian)
93 | * Beckhoff UK - Virtual Visits - Free videos from the team in Beckhoff UK (Currently offline)
94 | * [Beckhoff USA learning videos](https://learn.beckhoffus.com/catalog) - A collection of free videos teaching TwinCAT, TwinCAT/BSD, Vision, etc...
95 | * [Coding Bytes on YouTube](https://www.youtube.com/@benhar-dev) - Same Non-official Beckhoff video series from the members of Beckhoff Australia as below, but via YouTube
96 | * [Coding Bytes TwinCAT 3](https://codingbytes.teachable.com/p/codingbytes_twincat3) - Non-official Beckhoff video series from the members of Beckhoff Australia
97 | * [Coding Bytes TwinCAT HMI](https://codingbytes.teachable.com/p/codingbytes_twincathmi) - Non-official Beckhoff video series from the members of Beckhoff Australia
98 | * [Curso OOP IEC61131-3 PLC](https://github.com/runtimevic/OOP-IEC61131-3--Curso-Youtube) by **[Runtimevic](https://github.com/runtimevic)** - OOP IEC61131-3 PLC Course (Spanish)
99 | * [Electrical Automation Hands-On](https://www.youtube.com/channel/UCZqe2O5oBpas73BVdwHTiCA) - Hands-on and practice experience in industrial automation control (Includes TwinCAT)
100 | * [Jakob Sagatowski's YouTube channel](https://www.youtube.com/JakobSagatowski) - Comprehensive tutorials about PLC programming and TwinCAT 3
101 | * [Oleg Mueller’s YouTube channel](https://www.youtube.com/channel/UCHvABpkd825kAtaDxnhE-tg) - Video series conveys practical knowledge about TwinCAT 3 PLC and HMI
102 | * [PLC programming for beginners](https://www.youtube.com/playlist?list=PL2LjUivoqcmUNF4wfaZdWQEZm9ptpIFuw) - Youtube playlist by Prof. Dr. Stöcker, University of Applied Sciences Hamburg. Perfect for beginners, includes TwinCAT setup and IEC61131 basics (German).
103 | * [SquishyBrained YouTube channel](https://www.youtube.com/user/Evan5659) - Video series on PLC Programming and TwinCAT
104 | * [Threes Soup01 YouTube channel](https://youtube.com/@threessoup01) - Another must watch series by the very active Chris Chung.
105 | * [Beckhoff USA Webinar Wednesdays](https://www.blog.beckhoffus.com/events/webinar-series) - Webinar series from the Product Managers of Beckhoff USA
106 | * [Beckhoff USA Webinar Wednesdays on YouTube](https://www.youtube.com/playlist?list=PLSUMeALpvl4cii7kye3kHOb14BiUPnZRi) - Same video series as above, but recordings posted via YouTube
107 |
108 | ## Other
109 |
110 | *Non-TwinCAT related links, but worth looking at!*
111 |
112 | * [Design Patterns in Object Oriented Programming](https://www.youtube.com/playlist?list=PLrhzvIcii6GNjpARdnO4ueTUAVR9eMBpc) by **Christopher Okhravi** - This is a MUST WATCH video series!
113 | * [FunFunFunction](https://www.youtube.com/channel/UCO1cgjhGzsSYb1rsB4bFe4Q) by **MPJ** This is a fantastic series for learning JavaScript (great for TwinCAT HMI)
114 | * [Link for auto translated pages](https://translate.google.com/translate?hl=en&sl=en&u=beckhoff.com) - Modify this link to make an autotranslated page
115 |
116 | ## Modules & Features
117 |
118 | *A categorized collection of TwinCAT modules and their relevant guides, videos, and external documentation.*
119 |
120 |
121 | TE1xxx | Engineering Tools
122 |
123 | #### TE1000 | TwinCAT 3 Engineering
124 | ##### Core Boost
125 | ##### Tasks
126 | ##### Boot directory
127 | ##### Routing
128 | ##### Cookie Cutting
129 | ##### Installation
130 | ##### PLC Update without XAE
131 | ##### Corrected time stamps (NTP, DC, Application)
132 | ##### Libraries
133 | ##### Reference Libraries
134 | ##### PLC Open
135 | ##### Debugger (advanced debugging)
136 | ##### Event System
137 | #### TE1010 | TwinCAT 3 Realtime Monitor
138 | #### TE1030 | TwinCAT 3 Documentation Generation
139 | #### TE1111 | TwinCAT 3 EtherCAT Simulation
140 | #### TE1120 | TwinCAT 3 XCAD Interface
141 | #### TE1130 | TwinCAT 3 Interface for Inventor®
142 | #### TE1200 | TwinCAT 3 PLC Static Analysis
143 | #### TE1210 | TwinCAT 3 PLC Profiler
144 | #### TE1300 | TwinCAT 3 Scope View Professional
145 | #### TE1310 | TwinCAT 3 Filter Designer
146 | #### TE1320 | TwinCAT 3 Bode Plot Base
147 | #### TE1400 | TwinCAT 3 Target for Simulink®
148 | #### TE1401 | TwinCAT 3 Target for MATLAB®
149 | #### TE1402 | TwinCAT 3 Target for Embedded Coder®
150 | #### TE1410 | TwinCAT 3 Interface for MATLAB® and Simulink®
151 | #### TE1420 | TwinCAT 3 Target for FMI
152 | #### TE1421 | TwinCAT 3 Simulation Runtime for FMI
153 | #### TE1500 | TwinCAT 3 Valve Diagram Editor
154 | #### TE1510 | TwinCAT 3 Cam Design Tool
155 | #### TE1610 | TwinCAT 3 EAP Configurator
156 | #### TE1700 | TwinCAT 3 CoAgent
157 | #### TE2000 | TwinCAT 3 HMI Engineering
158 |
159 | * [Official Feature release notes](https://www.beckhoff.com/en-en/products/automation/twincat/texxxx-twincat-3-engineering/feature-release-notes-te2000-tf2000-twincat-3-hmi/) - Official Release notes from Beckhoff. Only feature additions.
160 | * [tchmi-hotkeys](https://github.com/benhar-dev/tchmi-hotkeys) - Proof of concept, add keyboard shortcuts to TcHmiButtons
161 | * [tchmi-keyboard-usermanagement-fix](https://github.com/benhar-dev/tchmi-keyboard-usermanagement-fix) - Proof of concept, add keyboard to user management
162 |
163 | ##### Project Generator
164 | ##### Framework Controls
165 | ##### Server Extensions
166 |
167 | * [TF2000_Server_Samples](https://github.com/Beckhoff/TF2000_Server_Samples) - Official Beckhoff Server Extension Samples (and [documentation](https://github.com/Beckhoff/TF2000_Server_Documentation))
168 | * [Python.Beckhoff.tchmi.extensionapi](https://github.com/Beckhoff/TF2000_Server_Documentation/tree/main/python) - TwinCAT HMI Python Extensions, part of the Python.Beckhoff.tchmi.extensionapi package
169 |
170 | ##### Nuget
171 | ##### Alarm
172 | ##### EtherCAT Diagnostics
173 | ##### EvenLogger
174 | ##### LDAP
175 | ##### MDP
176 | ##### OpcUa
177 | ##### PackML
178 | ##### PDF Viewer
179 | ##### Recipe Management
180 | ##### Responsive Navigation
181 | ##### Scope
182 | ##### Speech
183 | ##### Vision
184 | #### TE3500 | TwinCAT 3 Analytics Workbench
185 | #### TE3510 | TwinCAT 3 Analytics Vision
186 | #### TE3511 | TwinCAT 3 Analytics Energy
187 | #### TE3512 | TwinCAT 3 Analytics Condition Monitoring
188 | #### TE3520 | TwinCAT 3 Analytics Service Tool
189 | #### TE35x1 | TwinCAT 3 Analytics Maintenance
190 | #### TE3850 | TwinCAT 3 Machine Learning Creator
191 | #### TE5910 | TwinCAT 3 Motion Designer for drive dimensioning
192 | #### TE5950 | TwinCAT 3 Drive Manager 2
193 | #### TE5960 | TwinCAT 3 Autotuning
194 | #### TE6100 | TwinCAT 3 OPC UA Nodeset Editor
195 | #### TE8400 | TwinCAT 3 MTP Engineering
196 | #### TE9000 | TwinCAT 3 Safety Editor
197 | #### TE9100 | TwinSAFE Logic Simulator
198 | #### TE9200 | TwinSAFE Loader/User
199 |
200 |
201 |
202 | TC1xxx | TwinCAT 3 Base
203 |
204 | #### TC1000 | TwinCAT 3 ADS
205 | #### TC1100 | TwinCAT 3 I/O
206 | #### TC1200 | TwinCAT 3 PLC
207 | #### TC1210 | TwinCAT 3 PLC/C++
208 | #### TC1220 | TwinCAT 3 PLC/C++/MATLAB® and Simulink®
209 | #### TC1250 | TwinCAT 3 PLC/NC PTP 10
210 | #### TC1260 | TwinCAT 3 PLC/NC PTP 10/NC I
211 | #### TC1270 | TwinCAT 3 PLC/NC PTP 10/NC I/CNC
212 | #### TC1275 | TwinCAT 3 PLC/NC PTP 10/NC I/CNC E
213 | #### TC1300 | TwinCAT 3 C++
214 | #### TC1320 | TwinCAT 3 C++/MATLAB® and Simulink®
215 | #### TC1700 | TwinCAT 3 Usermode Runtime
216 | #### TC1701 | TwinCAT 3 Usermode Runtime: External Control
217 | #### TC1702 | TwinCAT 3 Usermode Runtime: Fast As Possible
218 |
219 |
220 |
221 | TF1xxx | TwinCAT 3 System
222 |
223 | #### TF1100 | TwinCAT 3 Controller Redundancy
224 | #### TF1200 | TwinCAT 3 UI Client
225 |
226 | * [codingbytes-tf1200-on-tcbsd](https://github.com/benhar-dev/codingbytes-tf1200-on-tcbsd) - Coding Bytes Mini - Installing TF1200 TwinCAT UI Client on TC/BSD
227 |
228 | #### TF1400 | TwinCAT 3 Runtime for MATLAB® and Simulink®
229 | #### TF1420 | TwinCAT 3 Runtime for FMI
230 | #### TF1800 | TwinCAT 3 PLC HMI
231 | #### TF1810 | TwinCAT 3 PLC HMI Web
232 | #### TF1910 | TwinCAT 3 UML
233 |
234 |
235 |
236 | TF2xxx | HMI
237 |
238 | #### TF2000 | TwinCAT 3 HMI Server
239 |
240 | * [tchmi-multi-screen](https://github.com/benhar-dev/tchmi-multi-screen) - Example using TcHmi on IPC with multiple screens (or multiple clients accessing different screens)
241 | * [electron-custom-browser](https://github.com/benhar-dev/electron-custom-browser) - Simple example of creating your own browser
242 |
243 | #### TF20x0 | TwinCAT 3 HMI Clients Packs
244 | #### TF20xx | TwinCAT 3 HMI Targets Packs
245 | #### TF2110 | TwinCAT 3 HMI OPC UA
246 | #### TF2200 | TwinCAT 3 HMI Extension SDK
247 | #### TF2300 | TwinCAT 3 HMI Scope
248 | #### TF2400 | TwinCAT 3 HMI Audit Trail
249 | #### TF24x0 | TwinCAT 3 HMI Audit Trail Symbols Pack
250 |
251 |
252 |
253 | TF3xxx | Measurement
254 |
255 | #### TF3300 | TwinCAT 3 Scope Server
256 | #### TF3500 | TwinCAT 3 Analytics Logger
257 | #### TF3510 | TwinCAT 3 Analytics Library
258 | #### TF3520 | TwinCAT 3 Analytics Storage Provider
259 | #### TF3550 | TwinCAT 3 Analytics Runtime
260 | #### TF3551 | TwinCAT 3 Analytics Runtime Base
261 | #### TF3600 | TwinCAT 3 Condition Monitoring
262 | #### TF3650 | TwinCAT 3 Power Monitoring
263 | #### TF3680 | TwinCAT 3 Filter
264 | #### TF3685 | TwinCAT 3 Weighing Library
265 | #### TF3710 | TwinCAT 3 Interface for LabVIEW™
266 | #### TF3800 | TwinCAT 3 Machine Learning Inference Engine
267 | #### TF3810 | TwinCAT 3 Neural Network Inference Engine
268 | #### TF3820 | TwinCAT 3 Machine Learning Server
269 | #### TF3830 | TwinCAT 3 Machine Learning Server Client
270 | #### TF3900 | TwinCAT 3 Solar Position Algorithm
271 |
272 |
273 |
274 | TF4xxx | Controller
275 |
276 | #### TF4100 | TwinCAT 3 Controller Toolbox
277 | #### TF4110 | TwinCAT 3 Temperature Controller
278 | #### TF4500 | TwinCAT 3 Speech
279 |
280 |
281 |
282 | TF5xxx | Motion
283 |
284 | #### TF5000 | TwinCAT 3 NC PTP 10 Axes
285 | #### TF5010 | TwinCAT 3 NC PTP Axes Pack 25
286 | #### TF5020 | TwinCAT 3 NC PTP Axes Pack unlimited
287 | #### TF5050 | TwinCAT 3 NC Camming
288 | #### TF5055 | TwinCAT 3 NC Flying Saw
289 | #### TF5060 | TwinCAT 3 NC FIFO Axes
290 | #### TF5065 | TwinCAT 3 Motion Control XFC
291 | #### TF5100 | TwinCAT 3 NC I
292 | #### TF5110 | TwinCAT 3 Kinematic Transformation L1
293 | #### TF5111 | TwinCAT 3 Kinematic Transformation L2
294 | #### TF5112 | TwinCAT 3 Kinematic Transformation L3
295 | #### TF5113 | TwinCAT 3 Kinematic Transformation L4
296 | #### TF5120 | TwinCAT 3 Robotics mxAutomation
297 | #### TF5130 | TwinCAT 3 Robotics uniVAL PLC
298 | #### TF5200 | TwinCAT 3 CNC
299 |
300 | * [ISG-kernel](https://www.isg-stuttgart.de/en/products/softwareproducts/isg-kernel/documents-and-downloads) - Introduction to TwinCAT system functions and motion control using the ISG kernel.
301 |
302 | #### TF5210 | TwinCAT 3 CNC E
303 | #### TF5220 | TwinCAT 3 CNC Axes Pack 64
304 | #### TF5221 | TwinCAT 3 CNC Axes Pack unlimited
305 | #### TF5225 | TwinCAT 3 CNC Measurement
306 | #### TF5230 | TwinCAT 3 CNC Channel Pack
307 | #### TF5240 | TwinCAT 3 CNC Transformation
308 | #### TF5245 | TwinCAT 3 CNC Kinematic Optimization
309 | #### TF5250 | TwinCAT 3 CNC HSC Pack
310 | #### TF5260 | TwinCAT 3 CNC Spline Interpolation
311 | #### TF5261 | TwinCAT 3 CNC Realtime Cycles
312 | #### TF5262 | TwinCAT 3 CNC Online Adaption
313 | #### TF5263 | TwinCAT 3 CNC Extended Interpolation
314 | #### TF5264 | TwinCAT 3 CNC Conveyor Tracking
315 | #### TF5270 | TwinCAT 3 CNC Virtual NCK Basis
316 | #### TF5271 | TwinCAT 3 CNC Virtual NCK Options
317 | #### TF5280 | TwinCAT 3 CNC Volumetric Compensation
318 | #### TF5290 | TwinCAT 3 CNC Cutting Plus
319 | #### TF5291 | TwinCAT 3 CNC AM Plus
320 | #### TF5292 | TwinCAT 3 CNC EDM Plus
321 | #### TF5293 | TwinCAT 3 CNC Milling Base
322 | #### TF5400 | Advanced Motion Pack
323 | #### TF5410 | TwinCAT 3 Motion Collision Avoidance
324 | #### TF5420 | TwinCAT 3 Motion Pick-and-Place
325 | #### TF5430 | TwinCAT 3 Planar Motion
326 | #### TF5810 | TwinCAT 3 Hydraulic Positioning
327 | #### TF5850 | TwinCAT 3 XTS Extension
328 | #### TF5890 | TwinCAT 3 XPlanar
329 |
330 |
331 |
332 | TF6xxx | Connectivity
333 |
334 | #### TF6000 | ADS Comm Lib
335 | #### TF6010 | TwinCAT 3 ADS Monitor
336 | #### TF6020 | TwinCAT 3 JSON Data Interface
337 | #### TF6100 | TwinCAT 3 OPC UA
338 | #### TF6100 | OPC UA Client
339 | #### TF6100 | OPC UA Configurator
340 | #### TF6100 | OPC UA Gateway
341 | #### TF6100 | OPC UA Server
342 |
343 | * [Beckhoff TC6100 OPC UA Configuration Setup Walk through](https://www.youtube.com/watch?v=JAchvzrzgSw) - Walkthrough video from Kim Smyth on Youtube
344 |
345 | #### TF6105 | TwinCAT 3 OPC UA Pub/Sub
346 | #### TF6120 | OPC DA
347 | #### TF6220 | TwinCAT 3 EtherCAT Redundancy 250
348 | #### TF6225 | TwinCAT 3 EtherCAT External Sync
349 | #### TF6230 | TwinCAT 3 Parallel Redundancy Protocol (PRP)
350 | #### TF6250 | TwinCAT 3 Modbus TCP
351 |
352 | * [electron-tf6250-server-test](https://github.com/benhar-dev/electron-tf6250-server-test) - TF6250 Server Test
353 |
354 | #### TF6255 | TwinCAT 3 Modbus RTU
355 |
356 | * [tc3-modbus-rtu-snippets](https://github.com/benhar-dev/tc3-modbus-rtu-snippets) - Code Snippet - Using Modbus RTU Master Function Block (TF6255)
357 |
358 | #### TF6270 | TwinCAT 3 PROFINET RT Device
359 | #### TF6271 | TwinCAT 3 PROFINET RT Controller
360 | #### TF6280 | TwinCAT 3 EtherNet/IP™ Adapter
361 | #### TF6281 | TwinCAT 3 EtherNet/IP™ Scanner
362 | #### TF6300 | TwinCAT 3 FTP Client
363 | #### TF6310 | TwinCAT 3 TCP/IP
364 | #### TF6311 | TwinCAT 3 TCP/UDP Realtime
365 |
366 | * [nodejs-udp-client](https://github.com/benhar-dev/nodejs-udp-client) - Simple tool for testing incoming UDP comms from TwinCAT Realtime UDP Example
367 |
368 | #### TF6340 | TwinCAT 3 Serial Communication
369 | #### TF6350 | TwinCAT 3 SMS/SMTP
370 | #### TF6360 | TwinCAT 3 Virtual Serial COM
371 | #### TF6420 | TwinCAT 3 Database Server
372 | #### TF6421 | TwinCAT 3 XML Server
373 | #### TF6500 | TwinCAT 3 IEC 60870-5-10x
374 | #### TF6510 | TwinCAT 3 IEC 61850/IEC 61400-25
375 | #### TF6600 | TwinCAT 3 RFID Reader Communication
376 | #### TF6620 | TwinCAT 3 S7 Communication
377 | #### TF6650 | TwinCAT 3 DBC File Import for CAN
378 | #### TF6680 | TwinCAT 3 FDT ComDTM
379 | #### TF6701 | TwinCAT 3 IoT Communication (MQTT)
380 | #### TF6710 | TwinCAT 3 IoT Functions
381 | #### TF6720 | TwinCAT 3 IoT Data Agent
382 | #### TF6730 | TwinCAT 3 IoT Communicator
383 | #### TF6735 | TwinCAT 3 IoT Communicator App
384 | #### TF6760 | TwinCAT 3 IoT HTTPS/REST
385 | #### TF6770 | TwinCAT 3 IoT WebSockets
386 | #### TF6771 | TwinCAT 3 IoT OCPP
387 |
388 |
389 |
390 | TF7xxx | Vision
391 |
392 | #### TF7xxx | TwinCAT Vision General
393 |
394 | * [TF7xxx_Samples](https://github.com/Beckhoff/TF7xxx_Samples) - Official sample code for TwinCAT 3 Vision
395 |
396 | #### TF700x | TwinCAT 3 GigE Vision Connector
397 | #### TF7020 | TwinCAT 3 Vision Beckhoff Camera Connector
398 | #### TF7100 | TwinCAT 3 Vision Base
399 |
400 | * [vision-golden-template](https://github.com/benhar-dev/vision-golden-template) - Code Snippet - Golden Template using TwinCAT Vision
401 | * [vision-F_VN_ApplyTranslationToAffineTransformation](https://github.com/benhar-dev/vision-F_VN_ApplyTranslationToAffineTransformation) - Code Snippet - F_VN_ApplyTranslationToAffineTransformation
402 | * [vision-F_VN_FitLine](https://github.com/benhar-dev/vision-F_VN_FitLine) - Code Snippet - F_VN_FitLine
403 |
404 | #### TF7200 | TwinCAT 3 Vision Matching 2D
405 | #### TF7250 | TwinCAT 3 Vision Code Reading
406 | #### TF7255 | TwinCAT 3 Vision Code Quality
407 | #### TF7260 | TwinCAT 3 Vision OCR
408 | #### TF7300 | TwinCAT 3 Vision Metrology 2D
409 | #### TF7800 | TwinCAT 3 Vision Machine Learning
410 | #### TF7810 | TwinCAT 3 Vision Neural Network
411 |
412 |
413 |
414 | TF8xxx | Industry-Specific
415 |
416 | #### TF8000 | HVAC
417 | #### TF8010 | Building Automation Basic
418 | #### TF8020 | TwinCAT 3 BACnet
419 | #### TF8040 | TwinCAT 3 Building Automation
420 | #### TF8050 | TwinCAT 3 Lighting Solution
421 | #### TF8310 | TwinCAT 3 Wind Framework
422 | #### TF8330 | TwinCAT 3 Power Collector
423 | #### TF8350 | TwinCAT 3 Power Technologies
424 | #### TF8360 | TwinCAT 3 Power Control
425 | #### TF8400 | TwinCAT 3 MTP Runtime
426 | #### TF8540 | TwinCAT 3 Plastic Processing Framework
427 | #### TF8550 | TwinCAT 3 Plastic HMI Framework
428 | #### TF8560 | TwinCAT 3 Plastic Technology Functions
429 | #### TF8810 | TwinCAT 3 AES70 (OCA)
430 |
431 |
432 |
433 | Addons
434 |
435 | #### SE1103-1100 | Beckhoff I/O VIs for LabVIEW™
436 |
437 |
438 |
439 | TwinSAFE
440 |
441 | #### General
442 |
443 | * [Learn TwinSAFE](https://www.youtube.com/@TwinSAFE) - Learn TwinSAFE in bite-sized chunks with the Beckhoff USA Product Manager.
444 |
445 |
446 |
447 | Libraries
448 |
449 | #### Motion
450 | ##### Tc3_DriveMotionControl
451 |
452 | #### Entertainment
453 | ##### ArtNet
454 | ##### Crestron
455 | ##### PJLink
456 | ##### PosiStageNet
457 | ##### Q-Sys | QRC
458 | ##### sACN | 2016
459 |
460 | #### General
461 | ##### Tc2_Coupler
462 | ##### Tc2_DALI
463 | ##### Tc2_DataExchange
464 | ##### Tc2_DMX
465 | ##### Tc2_EIB
466 | ##### Tc2_EnOcean®
467 | ##### Tc2_EtherCAT
468 | ##### Tc2_GENIbus
469 | ##### Tc2_IoFunctions
470 | ##### Tc2_LON
471 | ##### Tc2_Math
472 | ##### Tc2_MBus
473 | ##### Tc2_MDP
474 | ##### Tc2_MPBus
475 | ##### Tc2_ProfinetDiag
476 | ##### Tc2_SMI
477 | ##### Tc2_Standard
478 | ##### Tc2_SUPS
479 | ##### Tc2_SystemCX
480 | ##### Tc2_System
481 | ##### Tc2_SystemC69xx
482 | ##### Tc2_Utilities
483 |
484 | * [tc3-ps-network-adapter-control](https://github.com/benhar-dev/tc3-ps-network-adapter-control) - Network Adapter Control using Tc3, NT_StartProcess and Powershell
485 |
486 | ##### Tc3_BA_Common
487 | ##### Tc3_BA2_Common
488 | ##### Tc3_DALI
489 | ##### Tc3_DynamicMemory
490 | ##### Tc3_EtherCATDiag
491 | ##### Tc3_EventLogger
492 | ##### Tc3_IoLink
493 | ##### Tc3_IPCDiag
494 | ##### Tc3_JsonXml
495 |
496 | * [tc3-json-path-parser](https://github.com/benhar-dev/tc3-json-path-parser) - How to use the FB_JsonDomParser with path.
497 |
498 | ##### Tc3_Module
499 |
500 |
501 |
502 | Infosys
503 |
504 | #### Infosys | Installation
505 | #### Infosys | 4026 Specific Examples
506 |
507 | * [CreateCallstackCoreDump](https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_plc_intro/18677193867.html) - Infosys - Create core dump at runtime via PLC
508 |
509 |
510 |
511 | OS Support
512 |
513 | ### OS Support
514 |
515 | #### Windows | General
516 | #### Windows | Package Manager
517 |
518 | * [tcpkg-cheatsheet](https://github.com/benhar-dev/tcpkg-cheatsheet) - Common TwinCAT TcPkg Commands
519 | * [tcpkg-custom-library-package](https://github.com/benhar-dev/tcpkg-custom-library-package) - TcPkg Example - Create a library package
520 |
521 | #### Windows | Write Filter
522 | #### Linux | General
523 | #### Linux | Package Manager
524 | #### Linux | Docker / Hypervisor
525 | #### Linux | Multi-instance
526 | #### Linux | "Virtual PLC"
527 | #### TwinCAT BSD | General
528 |
529 | * [tcbsd-cheatsheet](https://github.com/benhar-dev/tcbsd-cheatsheet) - TwinCAT BSD Cheatsheet
530 |
531 | #### TwinCAT BSD | Package Manager
532 | #### TwinCAT RTOS
533 |
534 |
535 |
536 | Licensing
537 |
538 | #### TwinCAT XAR Activation
539 | #### TwinCAT XAR Transfer
540 | #### TwinCAT XAE Activation
541 | #### TwinCAT XAE Transfer
542 | #### Licence Terminal File Access
543 |
544 |
545 |
546 | ADS Examples
547 |
548 | #### ADS | JavaScript
549 |
550 | * [nodejs-structure-to-pdf](https://github.com/benhar-dev/nodejs-structure-to-pdf) - Structure to PDF
551 |
552 | #### ADS | Python
553 |
554 | * [pyads-cx7000-as-io](https://github.com/benhar-dev/pyads-cx7000-as-io) - Simple example of connecting any EtherCAT I/O to Python, using a CX7000
555 |
556 | #### ADS | C++
557 | #### ADS | C#
558 |
559 | * [ads-boot-mode](https://github.com/benhar-dev/ads-boot-mode) - ADS Control of TwinCAT Boot Mode
560 |
561 | #### ADS | Over MQTT
562 |
563 |
564 |
565 | Tools & Utilities
566 |
567 | #### Automation Interface
568 | #### AML DataExchange
569 | #### EAP
570 | #### EventLogger
571 | #### MultiUser
572 | #### Project Compare Tool
573 | #### Source Control
574 | #### Remote Manager
575 | #### Software Protection
576 | #### Variant Management
577 | #### Beckhoff Service Tool
578 | #### Beckhoff Device Manager
579 | #### UPS Software Components
580 | #### Trusted Platform Module (TPM)
581 |
582 |
583 |
584 | IO
585 |
586 | #### EL2574 | EtherCAT Terminal, 4-channel LED output, pixel LED
587 |
588 | [tc3-el2574-christmas-final](https://github.com/benhar-dev/tc3-el2574-christmas-final) - EL2574 Christmas Demo - Final Code
589 |
590 | #### EL7031 | EtherCAT Terminal, 1-channel motion interface, stepper motor, 24 V DC, 1.5 A
591 |
592 | [el7031-simple-position-control](https://github.com/benhar-dev/el7031-simple-position-control) - Example EL7xxx range with Positioning Interface
593 |
594 |
595 |
596 | Virtual Machines
597 |
598 | #### Virtual Machines | Setup
599 |
600 | * [nodejs-twincat-virtualbox-tool](https://github.com/benhar-dev/nodejs-twincat-virtualbox-tool) - Tools - Quick Make TwinCAT BSD and TwinCAT RT Linux Virtual Box VM
601 |
602 |
603 |
604 | ## 3rd Party Integration
605 |
606 | *A categorized collection of external technologies which may be used with or alongside TwinCAT.*
607 |
608 |
609 | Ignition
610 |
611 | #### Ignition Guides
612 |
613 | * [Electrical Automation Hands-On, TwinCAT and Ignition Setup](https://youtube.com/playlist?list=PL762SfoJC-e9CywYPwcDD_atUcSnAnB2b&si=fNwf70g4XQfG4JbN)
614 |
615 |
616 |
617 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------