Post by ingo on #105 new badges request
CODESYS Forge
support
(Post)
status: open --> wont-fix
Last updated: 2020-10-23
Home
CODESYS Forge
wiki
(WikiPage)
Download CODESYS SVN for free Welcome to CODESYS Forge! A place to find share and collaborate in open source projects, all focusing on automation solutions, especially using CODESYS. Nowadays you don't find automation software solely in a factory. Kitchen gadgets, Home Automation, Smart Home and Garden solutions are bringing customized automation software into everyones home. Everyone is highly welcome to become a member of every of the projects, hosted on this Website. All others are invited to browse the projects and repositories to get inspired or find usefull and impressive projects. If you plan a cool extension of CODESYS, or you are just realizing a cool project using CODESYS, you are welcome to initiate a new project on this platform. This way you can: share your experience share tutorials, tools and source code find other skilled developers who want to join your project promote your project to potential users This hosting platform is based on Apache Allura, which provides a numerous set of features to your projects: Wiki Pages SVN Repository Git Repository Bug Tracking Forum Blog Why should I use CODESYS Forge instead of Source Forge, GitHub, GitLab or similar platforms? There is definitely more than one reason: CODESYS Forge focuses on your project, not on repositories You can use CODESYS SVN for free to maintain your source code when you publish it on CODESYS Forge With cforge you get a perfect integration of CODESYS with CODESYS Forge Users can find all CODESYS related OSS projects in one place The Structure of the platform is optimized for CODESYS projects All members are working with similar tools and a similar background If you think about sharing your work on CODESYS Forge, please start reading the Project Maintenance guide and the Project Migration guide. To Log-In you can use your CODESYS Account. Have fun and enjoy your time on CODESYS Forge. All Users CODESYS Account User Accounts Following others Discussions Developers Project Maintenance Licensing Landing Page Source Code Repositories Providing Downloads Ticket Tool Migrating Projects Contribution Distributing OS software Permissions Continuous Integration Services CODESYS SVN FAQ Community Developer Community Legal Imprint / Impressum Terms of Service Privacy Policy
Last updated: 2018-11-07
User Accounts
CODESYS Forge
wiki
(WikiPage)
Multi E-Mail Company Accounts [[include IndexMain (already included)] In open source projects, every right and activity is focused on people. Everything works pretty independent of the companies where the people are employed. Multi E-Mail You can register multiple E-Mail addresses for your account. And we encourage you to use this feature to register your private and your company address in your profile, when you have the luck that your company allows you to contribute to open source project during work time. This way you personally keep the control over your rights, contributions and your reputation. Even when you change the company, you can take your account with you. Note, that one of your addresses has to be marked as the main address. This will be the one where notifications are sent to. But you can use both addresses for your account reactivation. Company Accounts All contributions are expected to be done by individuals. If maintainers are granting you rights on their projects, they do it because they are trusting you in person. So you should never contribute anything in your name if you are not behind it. If you are forced to do so by your company, you should create an anonymous company account for this purpose. But please make others clear that the persons using this account might change. We please you to use the companies domain name for this purpose. For example the user "codesys.com" is the company account of the CODESYS GmbH.
Last updated: 2018-05-02
Project Maintenance
CODESYS Forge
wiki
(WikiPage)
Project, User Project or Blog Post? Create a project Neighborhoods Projects Libraries Drivers Tools Targets Project Tools Rights Documentation ToC / Index Contribution Notes Legal Terms SVN / Git Bug Tracking Blog Post Embedding Videos Embedding Images Design and Content Hardware Layout / Design Parts for your Layout Project Logo [[include IndexMain (already included)] Project, User Project or Blog Post? If you want to publish your open source software, there are generally three approaches to start: Create and Maintain an Open-Source Project, shared with others Create a User Project, which is published in your profile Just publish your code and some pictures in your private Blog The decission should be easy: If you have serious plans with your project, choose option (1) If you just want to share your idea and use the SVN or Git infrastructure of Forge, choose option (2) If you just have a project, which you don't want to maintain, but share it once, choose option (3) Despite of your choice, you can use the Wiki or Blog post to: Describe your project in "markdown" syntax Embed Youtube Videos Embed Screenshots or Schematics Upload Files Create a project To create a project you need to: be logged in with your account know your neighborhood The login should be very streight forward, but what is a neighborood? Neighborhoods can be seen like fix categories in which you create your project. Technically they are special purpose projects which can also host documentation. Neighborhoods CODESYS Forge categorizes its projects into the following neighborhoods. Please take a look into the documentation of your choosen neighbourhood, to understand the rules which aply to it. Projects These are projects, realized with CODESYS. Some examples can be: a heating control system a control application for drones a weatherstation ... ... or even industrial applications where the knowhow is lying more in the materials, physical parts or mechanics, and where the software is only a small part. Why shouldn't companies share such knowledge, which is far away from their main business? Libraries CODESYS libraries are a special kind of a project, which can hold POUs, Visualizations, etc., which you want to share across various different applications and projects. Drivers This neighbourhood consists of all kind of software, which enables CODESYS to access any kind of hardware or remote software stacks. Tools This neighbourhood should contain all kinds of tools on the host or the target, which are interacting with CODESYS or extending the functionality of CODESYS or one of its applications. Targets CODESYS supports various open PLC platforms. This neighbourhood contains projects for all of those which are directly or indirectly supported. It's a place to collect hints, scripts, and documentation to operate those targets. It's mainly a place to share valuable information about those targets. Project Tools Every project can be configured differently. As the mainainer of such a project it is up to you to decide which tools of CODESYS Forge you want to use. Each tool can be added multiple times to a project, with different names. This allows you for example to have one Wiki for your documentation, one as a replacement of a full website and one containg your releases. By default multiple tools of the same type are grouped together. To avoid that, you have to: Click on the lock symbol on the right of the projects menu bar If you have already grouped menu entries, a setting named "group threshold" will appear. Just increase this value. Rights We recommend to keep your project open by default. This way you make it easy for others to contribute. To make it open, switch to the "Permissions" tab in tools and add "*authenticated" to the "Create" and "Edit" rights. This will allow every CODESYS Forge user to contribute to this project and this tool. By default, you will be notified via E-Mail when s.o. contributes to your project. Documentation Documentation might be the most important part of your project. It gives you the chance to explain your users what they can expect from your project and how it can be used. The documentation is written in form of a Wiki, like it is best known from Wikipedia. You can insert as many of those wikis with different names as you want. Before you start with your documentation you should have a look into projects of your neighbourhood. You might find plenty of good ideas there. The following are hints for some good practices to document your project. ToC / Index Your wiki will most likely grow and consist of different pages. It is generally a good idea to put some thoughts into the structure of your pages in advance. A good practice is to do this in form of an own wiki page, which consists solely of links to the pages you planed. Maybe with an additional "table of content" of the current page. * Installation * [Install the package](InstallPackage) * [Compile from source](InstallSource) ... This page can for example be named IndexMain and be included in every other page which you start afterwards. You can include a page like this: [TOC] [[include ref=IndexMain]] Contribution Notes Contributing to a project is not easy. You need to make yourself familar with the people behind the project, as well as the project structure coding rules restrictions commit rights branch and merge process .... To make it easier for your users to understand your rules, and for you to explain them, we collected a few process desciptions which might apply to you. You can link them on your own Contribution wiki page with the following link: [General rules for contribution](forge:documentation:Contribution) Legal Terms Please check the Terms of Service for more informations about the legal aspects of sharing code. You can freely choose a license under which your project is published. While encourage you to choose the MIT or Apache license, as those are giving your users the most rights. If some special constraints apply to your project, which are not covered by the general ToS, please add a documentation page for your users to clarify this. SVN / Git Please check the documentation regarding Souce Code Management. There you'll find a detailed description of your options. You can add as many code repositories to your project as you like and also name them as you like. Bug Tracking CODESYS Forge is featuring a minimalistic bug tracking system. Please check the documentation for a description of the ticket system. Blog Post To publish s.th. in your Blog, just use the link in your Dashboard. Embedding Videos To embed a video, you have to upload it to youtube first. The youtube link can then be embedded into your blog post. E.g.: ... I managed to get an amazon echo connected to my BBQ smoker. Check this out to see it in action: [[embed url=http://www.youtube.com/watch?v=XYZ]] Embedding Images Images can be directly attached to your post after you posted it. Sounds a bit strange, but you can only attach s.th. to the post after it exists. So if you want to embed an image into your blog post, you have to follow the following steps: Create your textual post Edit your post Attach your images Embed the image like this... Small Image: [[img src="Layout_schem.png/thumb"]] Full sized Image: [[img src="Layout_schem.png"]] Just use the file name of the image, or attach '/thumb' to get a smaller version of the image. The files can always be viewed by your users in full size by klicking on the attachment. Design and Content For us developers, it is often not easy to present our briliant ideas in a nice looking way. To make it a bit easier for you, we collected a few tips and tricks for an easy but nice looking presentation. Hardware Layout / Design Drawing a hardware layout is already a difficult task. If you add some more attributes to the task, it becomes a tough job: The layout should be accurate, so that it is easy to build for others. You should have some nice and colorful sketches for beginners. The images should not contain any images which have to be licensed. There is an open source tool, which enables everyone to create such neat sketches and layouts: Fritzing As it is conceptionally easier, you can start with a schematic: And for free, you get this nice looking sketch: Parts for your Layout Fritzing already contains lots of parts in its default installation. But here are a few ressources, where you can find larger libraries of parts: Adafruit Fritzing Parts Library Create your own Parts Project Logo As most of us are no designers, we provide you some Logo Icons, which can be used freely. They are based on the famous "font-awesome" set of icons. But they are preprocessed, so that they can be directly used as a project logo. You can find the icon set in this SVN repository Some examples... Building Code-Branch Code User-Secret
Last updated: 2021-04-02
Landing Page
CODESYS Forge
wiki
(WikiPage)
Plain Wiki Wiki w/o navigation bar SVN + WebDAV Find the page Use it as your landing page [[include IndexMain (already included)] While for developers functional tools are most important when it comes to open source hosting, users expect some professional and individual websites. Simplicity and flexibility are contrary requirements. But luckily the tools on CODESYS Forge are scaling very well in this respect. What you need to know is, that the first tool in the navigation bar of your project is automagically your landing page. Now you have various different options to design this page. Plain Wiki You can use an ordinary Wiki page where you describe your project. This is the easiest approach. Wiki w/o navigation bar In the admin settings tool, you can hide the navigation panel on the left. This way the page looks more like a web page than a Wiki page. Note, that you can open the settings even w/o the side pane. First, click on the lock symbol on the right. If you then click on the gear symbol beside your Wiki, you can open the settings again. SVN + WebDAV Every SVN repository on CODESYS Forge can be browsed with an ordinary web browser. This way you can commit some static web pages in your repository and link to them. Find the page You can find the URL of your page by entering the HTTP URL of your SVN repository into your browser. Now you should be able to navigate through the directory structure of your repository. After your clicked on your static page it should show up with all styles, images and scripts. Use it as your landing page Using such a page as your "landing page" is easy: Click on "Tool add..." Select "External Link" Enter your URL Name the tool "Home" or similar Click "Save" Click on the lock symbol on the right Drag the newly added tool to the very left From now on your static page should show up when you enter your project URL.
Last updated: 2019-02-21
SCM Repositories
CODESYS Forge
wiki
(WikiPage)
Subversion (SVN) Trunk Tags Branches CODESYS Project version Git Master Fork Tags CODESYS Libraries Merge Requests (aka Pull Requests) [[include IndexMain (already included)] For your project, you can choose between two different source code management systems. As CODESYS provides native support for SVN, we would always recommend that if you want to manage CODESYS projects. In every other cases, git has the huge advantage, that you can work locally, make even local commits, and push everything to the master repository only after you are satisfied with the result. Especially in distributed, open source projects, where all participants have their own goals, this is a huge advantage. Subversion (SVN) We recommend the use of the following tools: • SVN commandline tools • TortoiseSVN • CODESYS SVN In general you can work with the following workflow: Trunk Use the folder "trunk" to write and commit all your code Tags After you are satisfied with the software and you want to prepare a release, you can tag your trunk to a specific version. To do so, just use "svn copy" to copy "trunk" to "branchea/v1.0" Branches In Distributet Projects it is a good idea if not everyone is committing to the same trunk when they are developing larger features. It is recommended to create a "ticket" to describe the development and create a branch to develop this feature. After finish and review by other project members, one can then "merge" this change into the trunk. CODESYS CODESYS projects are usually saved in a propritary binary format. CODESYS SVN is an add on for CODESYS, which breaks this format out into several objects, which are then maintained in SVN. CODESYS itself is acting as the SVN client and the merge tool in this scenario. A CODESYS project, which is imported into SVN or checked out from SVN has a connection to this repository, very similar to a folder which you checked out with one of the other SVN clients. You should avoid to work in the same repository with different clients. So you should not use an SVN client like Tortoise SVN and CODESYS SVN on the same repository. The reason is, that the risk of committing specific files with the wrong tool is too high. To reduce this risk, you can use the tool cforge to checkout and update the repository on your PC, as cforge will not checkout internal files of CODESYS SVN. This is the layout, how cforge would commit the data, but which you should avoid when you maintain the repository without cforge: MyHeatingControl.project pumps.library sensors.library MyHeatingControl/... pumps/... sensors/... It is recommended to use a separated repository for CODESYS projects. Separating the code which is maintained with different SVN clients makes the handling of branches and tags easier. CODESYS SVN is usually a comercial add on for professionals. But it can be used for free to access repositories from CODESYS Forge. You can get it from the CODESYS Store. Project version CODESYS is always backward compatible. So you can use an older library or project always with a newer version of CODESYS. So usually you should not encounter any compatibility problems between you and your users, as they can always use the most current version of CODESYS. But converting the projects and libraries forth and back all the time is no good idea. So when you are working with a small team on a project, you should decide to use one specific project format within the team. The contineous integration system on CODESYS Forge is obviously also based on a specific version. So check the documentation if you work with that. Git Git works in many respects very similar to SVN. In the following we will point out the conceptional differences when working in a Team. We recommend the use of the following tools: • Git command line • Tortoise Git Note, CODESYS doesn't support Git at the moment. See the chapter below for more details. Master This is the version of the repository where everyone is working on. It can be compared to the "trunk" in SVN. Fork Every larger change should be done in a fork, which can be compared to SVN "branches". A fork can later be merged to the master. Tags Contrary to SVN a Tag in Git doesn't create a nee Revision. It just names this Revision. Actually it is more similar to CVS labels. Tags can be used to mark releases Versions. Release Tags shall only be used on the Master. CODESYS Libraries CODESYS supports to store projects or libraries in SVN. As you need CODESYS to resolve conflicts it is always a good idea to use an own Repository for CODESYS libraries or projects. Merge Requests (aka Pull Requests) In Git you can place so called "Merge Requests", which are very similar to "Pull Requests" on GitHub. You are free to use those on CODESYS Forge for your project. But, as we propose a multi-repository project layout in combination with SVN for CODESYS projects, we don't suggest it. To track branches, which need to be integrated, we recommend the use of Tickets.
Last updated: 2018-09-22
Downloads
CODESYS Forge
wiki
(WikiPage)
SVN / Git Cloud Services [[include IndexMain (already included)] Projects on CODESYS Forge are focusing mainly on developers. But if your project gains bigger popularity or focuses on users, you may want to make it easier for your users to download released versions of your software. You don't want them to struggle with SVN or Git. Our recommendation is to use a Wiki Page to do that. You can add a Wiki page named "Downloads" where you place links to your files. To upload your files, you have different choices. SVN / Git If they are not too big, you can commit the files into your repository beside your code during the creation of a new release. To link the files, you can either: copy a direct link from the repository browser for SVN, you can open the http / https URLs directly in a browser. This way you can link files or directories. e.g.: https://forge.codesys.com/svn/forge,icons,code/ http://forge.codesys.com/forge/icons/code/HEAD/tree/font-awesome/address-book.png?format=raw Cloud Services Many cloud services, like google drive, are allowing you to share direct links to your files, which can be used by others to download without creating an account. Those links can also be easily used in your Wiki, which is listing your releases.
Last updated: 2018-01-04
Tickets
CODESYS Forge
wiki
(WikiPage)
What ar tickets used for? Bug Tracking / Feature Request Merge Requests [[include IndexMain (already included)] What ar tickets used for? Tickets can be used for: • Bug tracking • Feature Requests or even to collect user input. In fact the ticket app can be configured to use different fields and a different workflow. So you can configure it for many kinds of use cases where you want to have a structured interface between people. To give you an example: Let's imagine your project has a built-in directory of supported web pages. You may create a ticket tracker, with much less fields as usual, where users might post URLs of new sites or report problems with existing ones. Anyway we will focus on the main use case here. And this is, that you have a ticket system, which tracks bugs and improvements in your software. Bug Tracking / Feature Request This kind of tickets always expects a change on the product. So they are always assigned to a milestone, which is usually one if the next releases. Most Open Source projects don't have the luxury of fix development ressources. So nobody can define a fix release schedule. But at least you can work with lists of tickets, which are planed to be implemented or fixed for the next release. The milestones are defined by the project mainainers. The tickets can usually be edited by everyone. The usual workflow of a ticket: graph LR Unread -> Open Open -> Accepted Open -> Won't fix Open -> Closed The commits for the tickets should always contain the Ticket number in the commit message. This makes it easier for others to review your changes and potentially merge them. Merge Requests In the chapter about Source Code management we recommended to use tickets ahead of "Merge Requests" in Git. The reason is, that: you can manage a ticket, which issues changes in more than one repository. it is possible to work on a branch in one repository and do a small direct change on trunk in another. The idea is to create a ticket and commit your stuff, referencing the ticket. To reference a ticket, just add the ticket number in brackets to your commit messages. For example: Created feature branch for ticket [#24] [#24] Fixed typo in build script Depending on the rights in the project, either the maintainer of the project or the developer who did the change can later on merge the changes back to "trunk" or "Master". This is usually done when a ticket is closed.
Last updated: 2019-11-30
IO Drivers
CODESYS Forge
wiki
(WikiPage)
Device Description Device identification Connector Interfaces Parameter Set Basic datatypes Structures Bit Channels [[include IndexMain (already included)] A very common way to integrate your own I/O drivers is to use an FB interface inside of a library. A much better way, and much more convenient from the usability is the integration in form of a real I/O driver. This approach should always been choosen when you decide to share your driver with others. To implement an I/O driver in CODESYS you need mainly two things: A device description An FB, implementing the I/O driver interface In the following you will find some general rules to follow while implementing your driver. Beside this guide, you should check out the different templates for different kinds of drivers to start from. Because in detail the implementation will be diffferent if you implement an SPI driver or you read a value from a sensor using a REST API. But independent of the kind of driver, which you plan to implement. If you are not routined in writing such software, it is a good idea to prove the access of the hardware directly in an application. Device Description Every device, which you can add to your CODESYS project, is described in an XML format inside of a Device Description. For finetuning and to get a deeper understanding of the format, please check out the schema file. In the following we will just explain the basics to enable you to write your first description. Device identification That the device can be uniquely identified in the device repository on every computer in the world, we need to maintain a few IDs. Please register the ID, which you will be using in the [DeviceDatabase]. Device Type: Either use the matching one from the templates, or use XXXXXX. VendorID: Use 0003, as this is reserved for all public domain drivers DeviceID: Use a unique one, which you added to the [DeviceDatabase] Version: You are free with that, but you should always increase it when you make changes to the device description Note: The combination of all IDs, described above has to be globally unique. Official versions of a driver with the same IDs, but different content shall never exist. Connector A device or module, which you can add to the device tree in CODESYS contains at least one connector. This connector is used to attach the module to a parent device. <Connector moduleType="8023" interface="Common.PCI" role="child" explicit="false" connectorId="1" hostpath="-1"> <InterfaceName name="local:PCI">PCI-Bus</InterfaceName> <Slot count="1" allowEmpty="false"></Slot> </Connector> moduletype: use 8000 + the DeviceID. This way you make sure, that you have no conflicts with other public domain drivers. interface: For submodules, like SPI, I2C, or similar, use the interface from the template. For all others, you can use Common.PCI. This interface can be easily attached to most PLCs. ConnectorID: simply enumerate the connectors within your modules. This ID is only used to specify the so called "host path" Interfaces Interfaces are symbolic names to match compatible connectors, so to find compatible devices or modules. We have some different concepts to configure our device tree in CODESYS. Variable Connectors You don't see anything in the device tree. But when you click on "Add Device" you get a list of all devices, which are providing an interface, that is compatible to the interfaces of the parent. The number of allowed devices which can be added to a variable connector can be varied. <Connector moduleType="8023" interface="OpenSource:Internal" role="parent" explicit="false" connectorId="2" hostpath="1"> <InterfaceName name="local:internal">Internal</InterfaceName> <Var max="4"></Var> Fix connectors Fix connectors are very similar to Variable connectors, but the devices are added implicitely and can't be changed. <Connector moduleType="8023" interface="OpenSource:FixConnectorInterface" role="parent" explicit="false" connectorId="2" hostpath="1"> <InterfaceName name="local:internal">Internal</InterfaceName> <Fixed> <!-- This is an example of a fixed module specified in the same file --> <Module> <LocalModuleId>8023</LocalModuleId> </Module> <!-- This is an example of a fixed module specified by DeviceIdentification. The defininition of this module is in another *.devdesc.xml --> <Module> <DeviceIdentification deviceType="40107" deviceId="0001 bcde" version="3.5.9.0"/> </Module> </Fixed> Slots Slots are again similar to variable slots. But the user can see the slot in the device tree. Because every slot has a fix place in the tree, and because the user can plug and remove the devices, the specialty for the driver is, that there can be empty slots. This was a huge preamble for an easy topic. But it was important that you get an idea of how the result will look like. Interfaces are easy. You define one interface per child connector and one for every parent connector. There are no fix restrictions for the interface names. But it is an unofficial rule, that they should be prefixed with a short or full name of the vendor. <Connector ConnectorId="2" HostPath="-1" interface="MyCompany.A" moduleType="40101" role="parent"> <Slot allowEmpty="false" count="16"/> </Connector> <Connector ConnectorId="3" HostPath="-1" interface="MyCompany.B" moduleType="40102" role="parent"> <Slot allowEmpty="false" count="16"/> </Connector> ... <Modules> <Module> <ModuleId>1701</ModuleId> <DeviceInfo> <Name name="localStrings:Name1704">Digital Input</Name> <Description name="localStrings:Desc1704"/> <Vendor name="localStrings:3S">3S-Smart Software Solutions</Vendor> <OrderNumber/> </DeviceInfo> <Connector ConnectorId="2" HostPath="-1" interface="MyCompany.A" moduleType="41101" role="child"> <Slot allowEmpty="false" count="1"/> <HostParameterSet> <Parameter ParameterId="1000" type="std:BIT"> <Attributes channel="input" download="true" functional="false" offlineaccess="readwrite" onlineaccess="readwrite"/> <Default>0</Default> <Name name="local:in1">in1</Name> </Parameter> </HostParameterSet> </Connector> </Module> <Module> <ModuleId>1702</ModuleId> <DeviceInfo> <Name name="localStrings:Name1705">Digital Output</Name> <Description name="localStrings:Desc1705"/> <Vendor name="localStrings:3S">3S-Smart Software Solutions</Vendor> <OrderNumber/> </DeviceInfo> <Connector ConnectorId="3" HostPath="-1" interface="MyCompany.A" moduleType="41102" role="child"> <Slot allowEmpty="false" count="1"/> <HostParameterSet> <Parameter ParameterId="1000" type="std:BIT"> <Attributes channel="output" download="true" functional="false" offlineaccess="readwrite" onlineaccess="readwrite"/> <Default>0</Default> <Name name="local:in1">in1</Name> </Parameter> </HostParameterSet> </Connector> </Module> <Module> <ModuleId>1703</ModuleId> <DeviceInfo> <Name name="localStrings:Name1705">Digital Output</Name> <Description name="localStrings:Desc1705"/> <Vendor name="localStrings:3S">3S-Smart Software Solutions</Vendor> <OrderNumber/> </DeviceInfo> <Connector ConnectorId="4" HostPath="-1" interface="MyCompany.B" moduleType="41103" role="child"> <Slot allowEmpty="false" count="1"/> <HostParameterSet> <Parameter ParameterId="1000" type="std:BIT"> <Attributes channel="output" download="true" functional="false" offlineaccess="readwrite" onlineaccess="readwrite"/> <Default>0</Default> <Name name="local:in1">in1</Name> </Parameter> </HostParameterSet> </Connector> </Module> <Module> <ModuleId>1704</ModuleId> <DeviceInfo> <Name name="localStrings:Name1706">PWM Output</Name> <Description name="localStrings:Desc1706"/> <Vendor name="localStrings:3S">3S-Smart Software Solutions</Vendor> <OrderNumber/> </DeviceInfo> <Connector ConnectorId="5" HostPath="-1" interface="MyCompany.B" moduleType="41104" role="child"> <Slot allowEmpty="false" count="1"/> </Connector> </Module> </Modules> Parameter Set A device can roughly hold two kinds of parameters: configuration parameters, which are important to initialize the I/O system I/O channels, which can be mapped to variables Both can be configured with the same structured datatypes. They can be located globally on device level, then they are called DeviceParameters. If they are part of the device that the user adds to the tree, then, they are called HostParameters and attached to one of its connectors. You can use virtually every datatype for a parameter, which can be used in IEC61131. This includes especially arrays and structures. But you have to be aware that you need to define those datatypes consistently twice (in your driver library and your device description). There is no extra check. If they don't match between your device description and your code, it will just not work, crash, or whatever... Some examples... Basic datatypes Basic datatypes don't need a declaration. They can be used with the namespace prefix "std". So "std:BOOL" is the equivalent of a BOOL datatype in IEC. DevDesc: <Parameter ParameterId="1000" type="std:DWORD"> <Attributes channel="input" download="true" functional="false" offlineaccess="write" onlineaccess="readwrite" /> <Default>0</Default> <Name name="local:DWIN">DWORD Input</Name> <Description name="local:DWIN.Desc">DWORD Input</Description> </Parameter> Structures IEC: TYPE DUT : STRUCT BYTE1 : BYTE; BYTE2 : BYTE; BYTE3 : BYTE; BYTE4 : BYTE; END_STRUCT END_TYPE DevDesc: <StructType name="local:Channel4Byte"> <Component identifier="Byte0" type="std:BYTE"> <Default /> <VisibleName name="local:Byte0">Byte0</VisibleName> </Component> <Component identifier="Byte1" type="std:BYTE"> <Default /> <VisibleName name="local:Byte1">Byte1</VisibleName> </Component> <Component identifier="Byte2" type="std:BYTE"> <Default /> <VisibleName name="local:Byte2">Byte2</VisibleName> </Component> <Component identifier="Byte3" type="std:BYTE"> <Default /> <VisibleName name="local:Byte3">Byte3</VisibleName> </Component> </StructType> ... <Parameter ParameterId="1000" type="local:Channel4Byte"> <Attributes channel="input" download="true" functional="false" offlineaccess="write" onlineaccess="readwrite" /> <Default>0</Default> <Name name="local:DWIN">DWORD Input</Name> <Description name="local:DWIN.Desc">DWORD Input</Description> </Parameter> Bit Channels IEC: TYPE DUT : STRUCT BYTE1 : BYTE; BYTE2 : BYTE; BYTE3 : BYTE; BYTE4 : BYTE; END_STRUCT END_TYPE DevDesc: <BitfieldType basetype="std:BYTE" name="Bitfield"> <Component identifier="Bit0" type="std:BOOL"> <Default /> <VisibleName name="local:Bitfield.Bit0">Bit0</VisibleName> </Component> <Component identifier="Bit1" type="std:BOOL"> <Default /> <VisibleName name="local:Bitfield.Bit1">Bit1</VisibleName> </Component> <Component identifier="Bit2" type="std:BOOL"> <Default /> <VisibleName name="local:Bitfield.Bit2">Bit2</VisibleName> </Component> <Component identifier="Bit3" type="std:BOOL"> <Default /> <VisibleName name="local:Bitfield.Bit3">Bit3</VisibleName> </Component> <Component identifier="Bit4" type="std:BOOL"> <Default /> <VisibleName name="local:Bitfield.Bit4">Bit4</VisibleName> </Component> <Component identifier="Bit5" type="std:BOOL"> <Default /> <VisibleName name="local:Bitfield.Bit5">Bit5</VisibleName> </Component> <Component identifier="Bit6" type="std:BOOL"> <Default /> <VisibleName name="local:Bitfield.Bit6">Bit6</VisibleName> </Component> <Component identifier="Bit7" type="std:BOOL"> <Default /> <VisibleName name="local:Bitfield.Bit7">Bit7</VisibleName> </Component> </BitfieldType> <StructType name="local:Channel4Byte"> <Component identifier="Byte0" type="local:Bitfield"> <Default /> <VisibleName name="local:Byte0">Byte0</VisibleName> </Component> <Component identifier="Byte1" type="local:Bitfield"> <Default /> <VisibleName name="local:Byte1">Byte1</VisibleName> </Component> <Component identifier="Byte2" type="local:Bitfield"> <Default /> <VisibleName name="local:Byte2">Byte2</VisibleName> </Component> <Component identifier="Byte3" type="local:Bitfield"> <Default /> <VisibleName name="local:Byte3">Byte3</VisibleName> </Component> </StructType> ... <Parameter ParameterId="1000" type="local:Channel4Byte"> <Attributes channel="input" download="true" functional="false" offlineaccess="write" onlineaccess="readwrite" /> <Default>0</Default> <Name name="local:DWIN">DWORD Input</Name> <Description name="local:DWIN.Desc">DWORD Input</Description> </Parameter>
Last updated: 2021-02-20
Contribution
CODESYS Forge
wiki
(WikiPage)
Best practices Communication Commit Code Submit changes for project page Summary of rules [[include IndexMain (already included)] Everyone who already tried to contribute to an open source project knows, that this can be a tricky task. Every project manages its code slightly different, defines different rights to commit, have different ways to communicate. On one project you have to apply for a mailing list and post patches On another project you commit to your own branch or fork Some may have strong coding guidelines Others are test driven developed and you need to pass a CI server Best practices As the scope of the projects on CODESYS Forge is very similar, we are defining some best practices here. But every project is still free to deviate from those rules. Communication If you need to contact one of the developers, just visit his profile and click on "send message". He will then receive an E-Mail. Some projects might have a Forum. If so, this should be the first place to ask questions Commit Code For a more detailed description about Source Code or Ticket Management visit the following pages: [SCM Repositories] [Tickets] Otherwise you should follow the following rules: Create a Ticket if it doesn't exist, yet Assign the ticket to you Maybe add some comments to the ticket about how you plan to solve the issue Now, it depends on your confidence: If the change is small and you have a high confidence, you can commit your change directly to "trunk" (SVN) or "Master" (Git). If the modification is bigger or you are not sure about your solution, you should commit it on a "branch" (SVN) or " Fork" (Git). If you commited directly to trunk/Master, you can now close the ticket. If you used a branch/Fork, set the status to "pending", add a comment to it and wait for a maintainer to integrate it. Note, in every commit, you have to reference your ticket. For a better transparency there should be no commit without a ticket number. Submit changes for project page You can't expect to get write access to all project pages. If you found bugs, typos, etc. on the pages, please create a ticket for that, describing the issue. If you want to rework a bit more of a page, you should get the code by clicking on "Show page source" in the footer. Make your changes and attach it to the ticket. Then an admin is able to integrate it after a review. Summary of rules Either commit directly on trunk/Master or create your own branch/Fork Name your branches or Forks after the corresponding ticket number. E.g.: "branches/ticket#26" Don't close a ticket, which isn't merged, yet Never commit w/o a ticket number Also for releases, you should create a ticket, to trace the work involved in the release process.
Last updated: 2019-11-30
Imprint
CODESYS Forge
wiki
(WikiPage)
Information according to Article 5 TMG (Telemediengesetz, German Act for telemedia services): 3S-Smart Software Solutions GmbH Memminger Straße 151 87439 Kempten / Germany Representatives: Dipl. Inf. Dieter Hess Dipl. Inf. Manfred Werner Contact: Phone: +49 831 54031-0 Fax: +49 831 54031-50 E-Mail: info@codesys.com Registration: Entry in the Register of Companies. Register Court: Amtsgericht Kempten Register/Company Number: Kempten HRB 61 86 Tax ID No.: Tax ID No. according to Article27a of the German Sales Tax Law (Umsatzsteuergesetz): DE 1 67 01 49 15 Reference pursuant EU reg. 524-2013, art. 14 (Online Dispute Resolution): Web page: http://ec.europa.eu/odr
Last updated: 2018-02-11
ToS
CODESYS Forge
wiki
(WikiPage)
Welcome Summary A. Definitions B. Account Terms C. Acceptable Use D. User-Generated Content E. Copyright & DMCA Policy CODESYS Forge Terms of Service A. Definitions B. Account Terms 1. Required Information 2. Account Requirements 3. User Account Security C. Acceptable Use 1. Compliance with Laws and Regulations 2. Content Restrictions 3. Conduct Restrictions 4. Services Usage Limits 5. Scraping 6. Privacy 7. Excessive Bandwidth Use 8. User Protection D. User-Generated Content 1. Responsibility for User-Generated Content 2. We may Remove Content 3. Ownership of Content, Right to Post, and License Grants 4. License Grant to Us 5. License Grant to Other Users 6. Contributions Under Repository License 7. Moral Rights E. Usage of Cookies F. Copyright Infringement and DMCA Policy G. This Agreement Welcome Thank you for using CODESYS Forge! We're happy you're here. Please read this Terms of Service agreement carefully before accessing or using CODESYS Forge. We provide our services in the hope to give a notable value back to the open source community and strengthen the open source autamation community. This ToS is based on the ToS of Github, which is thankfully published under the Creative Common Zero License. Summary A. Definitions Some basic terms, defined in a way that will help you understand this agreement. Refer back up to this section for clarification. B. Account Terms These are the basic requirements of having an account on CODESYS Forge. C. Acceptable Use These are the basic rules you must follow when using your CODESYS Forge account. D. User-Generated Content You own the content you post on CODESYS Forge. However, you have some responsibilities regarding it, and we ask you to grant us some rights so we can provide services to you. E. Copyright & DMCA Policy This section talks about how CODESYS GmbH will respond if you believe someone is infringing your copyrights on CODESYS Forge. CODESYS Forge Terms of Service A. Definitions Short version: We use these basic terms throughout the agreement, and they have specific meanings. You should know what we mean when we use each of the terms. The “Agreement” refers, collectively, to all the terms, conditions, notices contained or referenced in this document (the “Terms of Service” or the "Terms") and all other operating rules, policies and procedures that we may publish from time to time on the Website. The “Service” refers to the applications, software, products, and services provided on CODESYS Forge. The “Website” refers to the CODESYS Forge website located at forge.codesys.com, and all content, services, and products provided by CODESYS GmbH through this Website. “The User,” “You,” and “Your” refer to the individual person, company, or organization that has visited or is using the Website or Service; that accesses or uses any part of the account; or that directs the use of the account in the performance of its functions. A User must be at least 13 years of age. Special terms may apply for business or government accounts (See Section B(4): Additional Terms). “We,” and “Us” refer to CODESYS GmbH, as well as our affiliates, directors, subsidiaries, contractors, licensors, officers, agents, and employees. “Content” refers to content featured or displayed through the Website, including without limitation text, data, articles, images, photographs, graphics, software, applications, designs, features, and other materials that are available on the Website or otherwise available through the Service. "Content" also includes Services. “User-Generated Content” is Content, written or otherwise, created or uploaded by our Users. "Your Content" is Content that you create or own. B. Account Terms Short version: A human must create your account. You must be 13 or over. You must provide a valid email address. You may not have more than one account. You alone are responsible for your account and anything that happens while you are signed in to or using your account. You are responsible for keeping your account secure. 1. Required Information You must provide a valid email address in order to complete the signup process. Any other information requested, such as your real name, is optional. 2. Account Requirements We have a few simple rules for accounts on CODESYS Forge Service. You must be a human to create an account. Accounts registered by "bots" or other automated methods are not permitted. While it is allowed to do automated tasks with your own, private account. You are fully responsible for the actions of this account. We do not allow pure machine accounts. You must be age 13 or older. We do not target our Service to children under 13, and we do not permit any Users under 13 on our Service. If we learn of any User under the age of 13, we will terminate that User’s account immediately. If you are a resident of a country outside of Germany, your country’s minimum age may be older; in such a case, you are responsible for complying with your country’s laws. Your login may only be used by one person — i.e., a single login may not be shared by multiple people. An exception are company accounts, which can be shared by different people within this company. The company is responsible for the the actions of this adcount. The account has to carry the main domain name of the company as its display name. 3. User Account Security You are responsible for keeping your account secure while you use our Service. We offer tools such as two-factor authentication to help you maintain your account's security, but the content of your account and its security are up to you. You are responsible for all content posted and activity that occurs under your account (even when content is posted by others who have accounts under your account). You are responsible for maintaining the security of your account and password. 3S cannot and will not be liable for any loss or damage from your failure to comply with this security obligation. You will promptly notify 3S if you become aware of any unauthorized use of, or access to, our Service through your account, including any unauthorized use of your password or account. C. Acceptable Use Short version: CODESYS Forge hosts collaborative projects from all over the world, and that collaboration only works when our users are able to work together in good faith. While using the service, you must follow this Acceptable Use Policy, which includes some restrictions on content you can post, conduct on the service, and other limitations. In short, be excellent to each other. 1. Compliance with Laws and Regulations Your use of the Website and Service must not violate any applicable laws, including copyright or trademark laws, export control laws, or other laws in your jurisdiction. You are responsible for making sure that your use of the Service is in compliance with laws and any applicable regulations. 2. Content Restrictions You agree that you will not under any circumstances upload, post, host, or transmit any content that: is unlawful or promotes unlawful activities; is or contains sexually obscene content; is libelous, defamatory, or fraudulent; is discriminatory or abusive toward any individual or group; contains or installs any active malware or exploits, or uses our platform for exploit delivery (such as part of a command and control system); or infringes on any proprietary right of any party, including patent, trademark, trade secret, copyright, right of publicity, or other rights. 3. Conduct Restrictions While using CODESYS Forge, you agree that you will not under any circumstances: harass, abuse, threaten, or incite violence towards any individual or group, including 3S employees, officers, and agents, or other CODESYS Forge Users; use our servers for any form of excessive automated bulk activity (for example, spamming), or relay any other form of unsolicited advertising or solicitation through our servers, such as get-rich-quick schemes; attempt to disrupt or tamper with the servers of 3S in ways that could harm our Website or Service, to place undue burden on servers of 3S through automated means, or to access CODESYS Forge Services in ways that exceed your authorization; impersonate any person or entity, including any of our employees or representatives, including through false association with 3S, the CODESYS GmbH, or by fraudulently misrepresenting your identity or site's purpose; or violate the privacy of any third party, such as by posting another person's personal information without consent. 4. Services Usage Limits You agree not to reproduce, duplicate, copy, sell, resell or exploit any portion of the Service, use of the Service, or access to the Service without the express written permission of 3S. 5. Scraping Scraping refers to extracting data from our Website via an automated process, such as a bot or webcrawler. It does not refer to the collection of information through an official API of CODESYS Forge. You may scrape the website for the following reasons: Researchers may scrape public, non-personal information from CODESYS Forge for research purposes, only if any publications resulting from that research are open access. Archivists may scrape CODESYS Forge for public data for archival purposes. You may not scrape CODESYS Forge for spamming purposes, including for the purposes of selling CODESYS Forge Users' personal information, such as to recruiters, headhunters, and job boards. All use of CODESYS Forge data gathered through scraping must comply with the CODESYS Forge Privacy Statement. 6. Privacy Misuse of CODESYS Forge Users' Personal Information is prohibited. Any person, entity, or service collecting data from CODESYS Forge must comply with the CODESYS Forge Privacy Statement, particularly in regards to the collection of our Users' Personal Information (as defined in the CODESYS Forge Privacy Statement). If you collect any CODESYS Forge User's Personal Information from CODESYS Forge, you agree that you will only use the Personal Information you gather for the purpose for which our User has authorized it. You agree that you will reasonably secure any Personal Information you have gathered from CODESYS Forge, and you will respond promptly to complaints, removal requests, and "do not contact" requests from CODESYS Forge or CODESYS Forge Users. 7. Excessive Bandwidth Use If we determine your bandwidth usage to be significantly excessive in relation to other CODESYS Forge customers, we reserve the right to suspend your account or throttle your file hosting until you can reduce your bandwidth consumption. 8. User Protection You agree not to engage in activity that significantly harms our Users. We will resolve disputes in favor of protecting our Users as a whole. D. User-Generated Content Short version: You own content you create, but you allow us certain rights to it, so that we can display and share the content you post. You still have control over your content, and responsibility for it, and the rights you grant us are limited to those we need to provide the service. We have the right to remove content or close accounts if we need to. 1. Responsibility for User-Generated Content You may create or upload User-Generated Content while using the Service. You are solely responsible for the content of, and for any harm resulting from, any User-Generated Content that you post, upload, link to or otherwise make available via the Service, regardless of the form of that Content. We are not responsible for any public display or misuse of your User-Generated Content. 2. We may Remove Content We don't have the obligation to remove content. But we may remove any User-Generated content which either violates these terms of service or applicable law. 3. Ownership of Content, Right to Post, and License Grants You retain ownership of and responsibility for Content you create or own ("Your Content"). If you're posting anything you did not create yourself or do not own the rights to, you agree that you are responsible for any Content you post; that you will only submit Content that you have the right to post; and that you will fully comply with any third party licenses relating to Content you post. Because you retain ownership of and responsibility for Your Content, we need you to grant us — and other CODESYS Forge Users — certain legal permissions, listed in Sections D.4 — D.7. These license grants apply to Your Content. 4. License Grant to Us We need the legal right to do things like host Your Content, publish it, and share it. You grant us and our legal successors the right to store, parse, and display Your Content, and make incidental copies as necessary to render the Website and provide the Service. This includes the right to do things like copy it to our database and make backups; show it to you and other users; parse it into a search index or otherwise analyze it on our servers; share it with other users; and perform it, in case Your Content is something like music or video. This license does not grant CODESYS Forge the right to sell Your Content or otherwise distribute or use it outside of our provision of the Service. 5. License Grant to Other Users Any User-Generated Content you post publicly, including issues, comments, and contributions to other Users' repositories, may be viewed by others. By setting your projects to be viewed publicly, you agree to allow others to view and copy your data. If you set your projects to be viewed publicly, you grant each User of CODESYS Forge a nonexclusive, worldwide license to use, display, and perform Your Content through the CODESYS Forge Service and to reproduce Your Content solely on CODESYS Forge as permitted through its functionality. You may grant further rights if you adopt a license. If you are uploading Content you did not create or own, you are responsible for ensuring that the Content you upload is licensed under terms that grant these permissions to other CODESYS Forge Users. 6. Contributions Under Repository License Whenever you make a contribution to a repository containing notice of a license, you license your contribution under the same terms, and you agree that you have the right to license your contribution under those terms. If you have a separate agreement to license your contributions under different terms, such as a contributor license agreement, that agreement will supersede. Isn't this just how it works already? Yep. This is widely accepted as the norm in the open-source community; it's commonly referred to by the shorthand "inbound=outbound". We're just making it explicit. 7. Moral Rights You retain all moral rights to Your Content that you upload, publish, or submit to any part of the Service, including the rights of integrity and attribution. However, you waive these rights and agree not to assert them against us, to enable us to reasonably exercise the rights granted in Section D.4, but not otherwise. To the extent this agreement is not enforceable by applicable law, you grant CODESYS Forge the rights we need to use Your Content without attribution and to make reasonable adaptations of Your Content as necessary to render the Website and provide the Service. E. Usage of Cookies Cookies are used on CODESYS Forge to store user data. User session information is stored to keep track of the currently logged in user Data, entered by the user, is tracked to support the display of information to the user Cookies are not recored or tracked by CODESYS Forge for other reasons, than their direct purpose. F. Copyright Infringement and DMCA Policy If you believe that content on our website violates your copyright, please contact us in accordance with our Digital Millennium Copyright Act Policy. If you are a copyright owner and you believe that content on CODESYS Forge violates your rights, please contact us by emailing to forge@codesys.com. There may be legal consequences for sending a false or frivolous takedown notice. Before sending a takedown request, you must consider legal uses such as fair use and licensed uses. We will terminate the accounts of repeat infringers of this policy. G. This Agreement This user agreement is based on the terms of service, provided by Github. It has been modified to match the services, provided by CODESYS Forge. At the time this agreement was derived, the original was licensed under the Creative Commons Zero license, and could be found here. This agreement is also licensed under the Creative Commons Zero license.
Last updated: 2020-10-22
Forge
CODESYS Forge
wiki
(WikiPage)
Find Solutions Search through all software projects to find a good inspiration for solutions to your coding problems. You don't need to start CODESYS to browse the source code. You can do that directly on the Web page. Share Code Share your own projects, drivers and tools with others. Use CODESYS SVN for free to maintain your code. Get valuable feedback for your projects and find other developers, who contribute to your code. Professional Software You can use professional tools to develop professional software. Every project can be easily packed into a CODESYS Package, which can be installed by every user directly from the website. Stay updated Get informed if someone publishes s.th. in the projects, you are interested in. You can manage your registrations for specific notifications in your user account. Feedback You can use the integrated bug tracker, forum and commenting function to get a structured and very direct feedback from your users. Publish Provide HowTos and Tutorials to others, who are interested in similar topics as you.
Last updated: 2018-03-06
FAQ
CODESYS Forge
wiki
(WikiPage)
Content Can I upload Videos? Can I embed images in my comments / posts? How to resize embedded images? How can an embedded image be displayed in a blog post How to layout a good tutorial? How do I get rid of the left navigation bar in my Wikis? How can I get back the navigation bar after disabling it? How can I browse pages after disabling the left navigation? How can I navigate to a Wiki page without a link? Can I see the source code of foreign Wiki pages? Maintenance / Moderation How can I delete a project Can I mark posts in my Forum as sticky? How to ban forum users? Community Can I send links to specific code lines? How can I share one Forge Account between different CODESYS Accounts? What can I do to disable an account and free the claimed E-Mail address? Technical Is there a programatical API to access CODESYS Forge? [[include IndexMain (already included)] Content Can I upload Videos? You can't upload them on CODESYS Forge. But you can embed videos, which you uploaded to Youtube. To embed a video, you have to upload it to youtube first. The youtube link can then be embedded into your blog post. E.g.: ... I managed to get an amazon echo connected to my BBQ smoker. Check this out to see it in action: [[embed url=http://www.youtube.com/watch?v=XYZ]] Can I embed images in my comments / posts? To embed images, which are hosted on other websites, you can simply use the following markdown syntax to embed it: Syntax:  Example:  If you want to upload an image, and embed it into your post, you have to create your post first. This might sound a bit strange, but you can only attach files to existing posts. Create your textual post Edit your post Attach your images Embed the image like this... [[img src=attached-image.jpg alt=foobar]] How to resize embedded images? Embedded Images are usually embedded in their original size. When embedding photos, you usually want to make them as large as it fits good on the users device. The recommendation is to use an image size of 400px-600px and to embed it with a size, relative to the screen width. You can do this with the "img" markdown macro: [[img src=attached-image.jpg width=50%]] How can an embedded image be displayed in a blog post Embedding images with the "img" macro (s. above) is very convenient. But it doesn't work if it is an image, at the beginning of a blog post, which should be displayed on the blog overview page. You can workaround this easily, by embedding it with their full URL: [[img src=https://forge.codesys.com/prj/myprj/blog/2018/05/mypost/attachment/attached-image.jpg width=50%]] How to layout a good tutorial? You can layout your tutorial with everything that markdown provides you. But a good practice is, to follow similar rules as when you write a normal Wiki-Page: Add [TOC] at the top of the page This will provide the user an overview over all steps Use topics for every step and give them a short and pregnant name This will improve the [TOC], which you insereted at the top Use sub-topics to give the tutorial a structure Use "preformated text (starting and ending with ~~~) to highlight commands and code An example... [TOC] # Prerequisites ... # Prepare the hardware ## Wiring of the sensors ... ## Attaching the peripherals ... # Install Linux ## Download the Image ... ## Copy the Image to your SD Card ... How do I get rid of the left navigation bar in my Wikis? In the Admin Options of your Wiki, you can disable the setting "Show left bar". Show Discussion: [x] Show left bar: [ ] Show meta data: [x] Allow replies via email: [x] How can I get back the navigation bar after disabling it? After the navigation bar is gone, you can't reach the Options menu anymore to reenable it. To get this options menu, just click on the "locker icon" on the right of the menu. Then, press on the gears, which will appear infront of the wiki menu entry. By clicking on the gear, you will get the admin menu as a drop down menu. You can select "Options", and reenable it in the same way as you disabled it. How can I browse pages after disabling the left navigation? One trick is to click on "history". Then you get the left navigation back. How can I navigate to a Wiki page without a link? This happens often when you use for example, the "IndexMain" page, how we recommended it in Project Maintenance. As the page "IndexMain" is only included, but not linked anywhere. You can use the button "Browse Navigation" of your Wiki to find such pages. This should give you a list of all pages, of this Wiki. Another way is to use the Wiki Search. If you disabled the left navigation bar, the easiest way is to enter the link in your browser directly. Just append the name of the Page (in our case "IndexMain") to the URL, directly after the name of the Wiki-Tool: If this is your start page: https://forge.codesys.com/proj/myproj/wiki/Home/ Enter: https://forge.codesys.com/proj/myproj/wiki/IndexMain If you renamed the Wiki, e.g. to: https://forge.codesys.com/proj/myproj/documentation/Home/ Enter: https://forge.codesys.com/proj/myproj/documentation/IndexMain Can I see the source code of foreign Wiki pages? When you are on a Wiki-Page, you should see a link named "Show Page Source". Click on it, and you can watch or copy the source of the Wiki-Page. Maintenance / Moderation How can I delete a project Actually projects are always only marked as deleted. You can whipe the content manually by deleting all the tools, etc. But the project itself will be kept in the database as a sort of placeholder. So for example nobody can take the short name afterwards anymore. To do this: Open the "Admin" page Click on "Metadata" Click on the "Edit-Link" beside "Project Status" Select "Delete Project" If you wish to delete the project fully and permanently, please contact forge@codesys.com and name the project you want to be deleted. Note, that you need to be an admin of the project, and that you need to do the contact with an the E-Mail address of your CODESYS Account. Can I mark posts in my Forum as sticky? Yes. Just navigate to the post. Open it, and click on the "hand symbol" above it. This is your moderator menu. There you can mark it as sticky. How to ban forum users? To ban a user from your forum, you need to take him the right to post s.th. To do this, you have to follow: Admin Forum Permissions Post Block User Then you enter the username. Community Can I send links to specific code lines? This is a bit different for CODESYS projects and libraries, as for other code, that is committed in your repositories. CODESYS libraries are exported as markdown. Therefore you can't refer a specific line in a link, but only sections. So, when you click on a link at the top of you source code page, you can copy and send this link to others. Every other code, which you can browse in the source browser, can be referenced by specific lines. Just click on a specific line, and copy the URL from your browsers location bar. For example: https://forge.codesys.com/drv/io-drivers/code/HEAD/tree/trunk/I2C_Template.devdesc.xml#l21 How can I share one Forge Account between different CODESYS Accounts? You can go to the account profile and claim a new E-Mail address. You will get an activation link sent to this E-Mail address which you need to visit. Once your address is approved, you can login, using a CODESYS Account which is registered to this address. Note, that each address can only be claimed once. Therefore this procedure only works if there is no other account which claimed the address, and when you respect the exact order (first claim the address, then login with the CODESYS Account for the first time). What can I do to disable an account and free the claimed E-Mail address? You can't remove the last E-Mail address from an account. Ther needs to be always one verified E-Mail address for every active account. So, if you want to remove all E-Mail addresses from an account, you need to disable it. To do this, go to "Account -> Preferences", and select "Disable account". Technical Is there a programatical API to access CODESYS Forge? There is a REST API, which is provided by Allura. The easiest way is, to prepend "/rest/" to your URL. e.g.: https://forge.codesys.com/forge/wiki/Home/ https://forge.codesys.com/rest/forge/wiki/Home/ ... gives you the pages source, some information about related artifacts, authors, ... Or if you want to process informations from a ticket system: https://forge.codesys.com/forge/support/ https://forge.codesys.com/rest/forge/support/ This works for most tools, and allows you to get some of the informations in json format.
Last updated: 2019-11-30
Distribution
CODESYS Forge
wiki
(WikiPage)
License owner / License holder Redistribution Comply in development Comply in distribution Software bill of material (BOM) Source Code Summary [[include IndexMain (already included)] Even when we start programming on a totally new piece of software, we might quickly get in contact with 3rd party licenses, which are often open source licenses. We might face this issue already during development, but latest when we prepare the distribution of our software. Because then we need to decide how we can prepare a package, containing all the dependencies to libraries or even programming language interpreters (e.g. Python), which the user might need to use our software. Even if licenses are very often standardized, you are recommended to read through the terms of every project that you will redistribute before doing so. The following shows the requirements of the most popular open source licenses: GPL LGPL BSD Apache MIT The following instructions should provide you some ideas about how you can solve the typical problems which you will face. But be aware, that the legal aspects have to be assessed by yourself in every single case. License owner / License holder By default the originator of a software is initially the license owner of the software. He can grant licenses to others and even allow others to redistribute or sublicense the software. To grant the right to others in a structured way, many license owners are putting the software under a standard license, like the ones listed above. In this article, we will focus on a special type of those standard licenses, which are typically called "open source licenses". Redistribution It is important that we make ourself clear about our role. When we use open source software in our own programs, it makes a huge difference if we use this software just for ourself, or if we distribute it to others. As soon as we use the software in some device that we give or sell to others, or when we provide the software for download, we become a distributor. On the other hand, if we just installed the software on a server, and provide web services to others, we will not distribute but just use it. So, in one case, we are a user, in the other case we are a distributer. In both cases we will become a license holder. But in case we are distributing, we need the special right to issue licenses to others. Here is an example text, from the apache license, which is granting us the right for sub-licensing and distribution: 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. As soon as you start to become a distributor, the below requirements will start to apply to you. Comply in development As a developer, it is important to know what a 3rd part licensed product allows me to do with it, before I integrates it into my project. There are several ways how the systems can interface with each other. But if we want to retain our freedom to choose our own license, we can't use every of them with every license. Binary interface Call another binary Interface via IPC Use an interpreter Linking Dynamic Static ... binary interface dynamic linking static linking GPL. allowed not allowed not allowed LGPL. allowed allowed not allowed BSD. allowed allowed. allowed Apache allowed allowed allowed MIT allowed allowed. allowed Note, that you can even use combinations, which are marked as "not allowed", but you loose some rights on your software in that case. Comply in distribution The actions that needs to be taken, actually depend on the kind of license. As the number of licenses are huge, we can't list all of them. Here are the actions for the popular licenses, listed above: ... include license text include NOTICE file publish source code MIT yes no no Apache yes yes no BSD yes no no LGPL yes no no GPL yes no yes The license texts and the NOTICES can be provided either: in a "software bill of material" in the license text of an installer in an about dialog of a software in a user manual Software bill of material (BOM) The american "Cyber Supply Chain Management and Transparency Act of 2014" forced all american software suppliers to provide a bill of material for their software. This typically included also a list of all licenses, which are involved. Even if this act is pending now, it is still a good idea to keep such a list for every released software package. Even if you include already the license information in your installer, documentation, ... . Because this will make life of redistributers much easier. So ideally you provide: a list of all 3rd party software the full license texts for each software everything whats necessary to rebuild the software Source Code The source code typically needs to be provided only on request, and in a form that it can be rebuild. But it is recommended to provide them to every user. For open source software it can be published as a download For other software it can be provided as part of the delivery This way we make it easier for users of our software to redistribute it. As they can include our BOM, and our sources into their BOM and their sources. Summary If you use open source software, and you want to safely redistribute it, the following is a good practice: Setup your bill of material (BOM) Read the license texts Prepare the BOM for every medium, in which you need to include it Pack the sources together Include the BOM and source package in every distribution This approach tries to be as compliant as possible, and will use the most strict license as a reference for all others. This way you don't need to deal with exceptions. There are some licenses which have more requirements (like advertising clauses, etc.). Make sure that you assess and respect them in your distributions.
Last updated: 2018-03-23
CODESYS Account
CODESYS Forge
wiki
(WikiPage)
Single Sign On Registration Login with Forum account Problems with registration [[include IndexMain (already included)] Single Sign On In the near future your CODESYS account will enable you to access all CODESYS webservices without the need for an additional registration. CODESYS Forge is proud to be the first service which is able to use the CODESYS Account, but we expect that the CODESYS Store and - Forum will follow soon. Registration Just follow the registration link on the Login Form to create a new account. Login with Forum account During the migration of the CODESYS Forum, all Forum users, are already created in CODEYS Forge. But to login to your account, you first need to create a valid CODESYS Account. Just make sure, that you create the account with the same E-Mail address, that you used in the CODESYS Forum, then your posts will be assigned to your account when you login to CODESYS Forge. Problems with registration If you encounter any problems with your registration, please create a support ticket, or write an E-Mail to forge@codesys.com.
Last updated: 2020-03-03
Privacy Policy
CODESYS Forge
wiki
(WikiPage)
A. General information B. Specific information Data protection declaration Principles of data processing Data transfer to third parties Duration of storage of your personal data Contact What are your rights? a) Right to information b) Right to correction c) Right to block d) Right to cancellation e) Right to data transferability f) Right of appeal to a supervisory authority g) Right of objection Protection of your personal data Your personal data will be protected in the following ways (excerpt): Protection of minors Cookies Control of cookies by the user Use of YouTube Use of RSS-Feeds Registration on CODESYS Forge Publishing data on the website Subscription to changes on the website Changes to our privacy policy Trademark protection We, CODESYS GmbH, are responsible for this website and, as the provider of a teleservice, must inform you at the beginning of your visit to our website about the nature, scope and purposes of the collection and use of personal data in a precise, transparent and understandable form. The content of the information must be available to you at all times. We are therefore obliged to inform you which personal data is collected or used. Personal data are all information relating to an identified or identifiable natural person. We attach great importance to the security of your data and compliance with data protection regulations. The collection, processing and use of personal data is subject to the provisions of the currently applicable European and national laws. With the following data protection declaration we would like to show you how we handle your personal data and how you can contact us. CODESYS GmbH Memminger Str. 151 87439 Kempten, Deutschland Commercial Register HRB 6186 Managing Directors: Dieter Hess, Manfred Werner Telephone: +49 831 64031-0 E-Mail: info@codesys.com Our data protection officer You can contact our external data protection officer as follows: PCK IT Solutions GmbH Martin Kuschke Edisonstr. 1 87437 Kempten, Germany E-mail: datenschutz@codesys.com Web: www.pck-it.de A. General information For reasons of easier legibility, gender-specific differentiation is not used. The same terms apply to both genders in the sense of equal treatment. Article 4 of the EU General Data Protection Regulation (GDPR) sets out what the terms used, such as "personal data" or their" processing", mean. The personal user data processed in the context of this online offer include inventory data (e.g. names and addresses of customers), contract data (e.g. services used, names of clerks, payment information), usage data (e.g. websites visited on our online offer, interest in our products), and content data (e.g. entries in the contact form). "Users" includes all categories of persons affected by data processing. This includes, for example, our business partners, customers, interested parties and other visitors to our online offering. B. Specific information Data protection declaration We guarantee that we will only collect, process, store and use your data in connection with the processing of your inquiries, as well as for internal purposes, and to provide services or content requested by you. Principles of data processing We process personal data of users only in compliance with the relevant data protection regulations. User data will only be processed if the following legal provisions exist To provide our contractual services (e.g. processing of orders) and online services. Processing is required by law. If you have given your consent. Due to our legitimate interests (i.e. optimization, economic operation and security of our online offer within the meaning of Art. 6/1 lit. f. DSGVO (General Data Protection Regulation), especially when creating profiles for advertising and marketing purposes) We would like to show you where the above legal bases are laid down in the GDPR: Consent: Art. 6/1 sub-par. a. and Art. 7 DSGVO (GDPR) Processing for the performance of our services and implementation of contractual measures: Art. 6 Par. 1 sub-par. b, GDPR Processing for compliance with our legal obligations: Art. 6 Par. 1 sub-par. c, GDPR Processing for the purposes of our legitimate interests_ Art. 6 Par. 1 sub-par. f, GDPR Data transfer to third parties Data will not be passed to third parties. Duration of storage of your personal data We adhere to the principles of data economy and data avoidance. This means that we only store the data provided to us for as long as necessary to fulfil the aforementioned purposes or as long as the various storage periods provided for by the legislator stipulate. If the re-spective purpose does not apply any more, or after the expiry of the corresponding periods, your data will be blocked or deleted as a matter of routine and in accordance with the statutory provisions. To ensure this procedure, we have developed an internal company concept. Contact If you contact us via e-mail or contact form, you agree to electronic communication. In the context of contacting us, personal data is collected. Which data is collected in the case of a contact form can be seen from the respective contact form. Your data will be transmitted SSL-encrypted. The information you provide will only be stored for the purpose of processing your inquiry and for possible follow-up questions. Processing for the performance of our services and implementation of contractual measures: Art. 6 Par. 1 sub-par. b GDPR Processing for the protection of our legitimate interests: Art. 6 Par. 1 sub-par. f GDPR We use software for the maintenance of customer data (ERP system) or comparable software based on our legitimate interests (efficient and fast processing of user inquiries). The system is operated by us inhouse. No data is therefore passed on to third parties. We would like to point out that e-mails can be read or changed during transmission without authorization and unnoticed. Furthermore, we would like to draw your attention to the fact that we use a software for filtering unsolicited e-mails (spam filter). The spam filter can reject emails that have been falsely identified as spam by certain features. What are your rights? a) Right to information You have the right to obtain information about your stored data free of charge. Upon request, we will inform you in writing what personal data we have stored about you in accordance with applicable law. This also includes the origin and recipients of your data as well as the purpose of data processing. b) Right to correction You have the right to have your data stored with us corrected if it is incorrect. In this case, you can request a restriction of the processing, e.g. in the event that the accuracy of your personal data is contested. c) Right to block You can also have your data blocked. To ensure that your data can be blocked at any time, this data must be kept in a lock file for control purposes. d) Right to cancellation You can also request the deletion of your personal data, as far as no legal storage obligations exist. If such an obligation exists, we will block your data on request. If the corresponding legal requirements are met, we will delete your personal data even if you do not request it. e) Right to data transferability You are entitled to require us to provide the personal data transmitted to us in a format that permits the transmission to another party. f) Right of appeal to a supervisory authority You can complain to one of the data protection supervisory authorities. Bavarian Data Protection Authority (BayLDA) Promenade 27, 91522 Ansbach, Deutschland Telefon: +49 981 53-1300 Telefax: +49 981 53-981300 You can follow this link to open the complaint form of the Bavarian Data Protection Authority: https://www.lda.bayern.de/en/complaint.html g) Right of objection You have the possibility to revoke the use of your data for internal purposes at any time with effect for the future. All you need to do is send an e-mail to datenschutz@codesys.com. However, such revocation does not affect the lawfulness of the processing procedures carried out by us up to that point. This does not affect data processing with regard to all other legal bases, such as the initiation of a contract (see above). Protection of your personal data We take contractual, organizational, and technical security measures in accordance with the state of the art to ensure that the provisions of data protection laws are observed and thus to protect the data processed by us against accidental or intentional manipulation, loss, destruction, or against access by unauthorized persons. The security measures include in particular the encrypted transmission of data between your browser and our server. A 256-bit SSL (AES 256) encryption technique is used for this purpose. Your personal data will be protected in the following ways (excerpt): In order to protect the confidentiality of your personal data stored with us, we have taken various measures for physical and virtual access control. Protecting the integrity of your personal data In order to maintain the integrity of your personal data stored with us, we have taken various measures for transfer and input control. Maintaining the availability of your personal data In order to maintain the availability of your personal data stored with us, we have taken various measures for order and availability control. The security measures in use are continuously improved in line with technological developments. Despite these precautions, due to the insecure nature of the Internet, we cannot guarantee the security of your data transmission to our online offer. Therefore, any data transmission from you to our online offer is at your own risk. Protection of minors Persons under 16 years of age may not transmit any personal data to us without the consent of their legal guardians. Personal information may only be made available to us by persons under the age of 16 with the express consent of their parents or legal guardians, or if the persons have reached the age of 16 or are older. These data will be processed in accordance with this data protection declaration. Cookies We use cookies. Cookies are small text files that are stored locally in the cache of your Internet browser. Cookies enable the recognition of the Internet browser. The files are used to help the browser navigate through the online offer and to be able to use the full range of functions. Our online offer uses browser cookies. Control of cookies by the user Browser cookies: You can set all browsers to accept cookies only on request. Also, only cookies whose pages are currently being visited can be accepted. All browsers offer functions that enable the selective deletion of cookies. The acceptance of cookies can also be generally switched off, however, restrictions in the user-friendliness of this online offer may have to be accepted. Use of YouTube Our online offer includes functions of the YouTube service for displaying and playing videos. These features are offered through YouTube, LLC 901 Cherry Ave. San Bruno, CA 94066 USA. Further information can be found in YouTube's privacy policy. The extended data protection mode is used here, which, according to the provider, does not initiate the storage of user information until the video(s) are played. When starting embedded YouTube videos, YouTube uses cookies to collect information about user behavior. According to YouTube, these serve, among other things, to collect video statistics, to improve user-friendliness, and to prevent abusive practices. Irrespective of the playback of the embedded videos, a connection to the Google network "DoubleClick" is established each time our website is accessed, which can trigger further data processing activities without our influence.Further details about the use of cookies on YouTube can be found in YouTube's privacy policy at: http://www.youtube.com/t/privacy_at_youtube Use of RSS-Feeds We use RSS feeds to keep you up to date on current topics. RSS stands for "Really Simple Syndication". This is an electronic message format. In order to use the feed, you need a socalled "RSS reader". Different RSS readers are available for all operating systems. Some browsers allow the use of RSS feeds without the need to install another program. Registration on CODESYS Forge Users have the possibility to register on this website with the indication of personal data. Which personal data are transmitted to 3S-Smart Software Solutions GmbH is determined by the respective input mask used for the registration. The personal data entered by the user are collected and stored exclusively for internal use by 3S-Smart Software Solutions GmbH. By registering on the CODESYS Forge website, the IP address - assigned by the Internet service provider (ISP) and used by the visitor - date, and time of the registration are also stored. The storage of this data takes place against the background that this is the only way to prevent the misuse of our services, and, if necessary, to make it possible to investigate committed offenses. This data is not passed on to third parties unless there is a statutory obligation to pass on the data, or if the transfer serves the aim of criminal prosecution. The registration of the data subject, with the voluntary indication of personal data, is intended to enable 3S-Smart Software Solutions GmbH to offer the data subject contents or services that may only be offered to registered users due to the nature of the matter in question. Registered persons are free to change the personal data specified during the registration at any time, or to disable their account. If they want to have their account deleted completely, they have to contact 3S-Smart Software Solutions GmbH. 3S-Smart Software Solutions GmbH shall, at any time, provide information upon request to each registered user as to what personal data are stored about this specific user. In addition, 3S-Smart Software Solutions GmbH shall correct or erase personal data at the request or indication of the registered user, insofar as there are no statutory storage obligations. To contact 3S-Smart Software Solutions GmbH in this respect, the registered user shall write to forge@codesys.com. Publishing data on the website 3S-Smart Software Solutions GmbH offers users the possibility to add content to the website via comments, blogs, wiki pages, forums or source code repositories. If a user adds content to the website, the data made by the user are also stored and published, as well as information on the date of the publishing event and on the display name chosen by the user. In addition, the IP address assigned by the Internet service provider (ISP) to the user is also logged. This storage of the IP address takes place for security reasons, and in case the user violates the rights of third parties, or posts illegal content. The storage of these personal data is, therefore, in the own interest of 3S-Smart Software Solutions GmbH, so that they can exculpate in the event of an infringement. This collected personal data will not be passed to third parties, unless such a transfer is required by law or serves the aim of the defense of 3S-Smart Software Solutions GmbH. The data, which was published by the user, can also be deleted by the user. In case that a deletion by the user himself is technically not possible, he might request a deletion through 3S-Smart Software Solutions GmbH, by sending an e-mail to forge@codesys.com. On deletion, not all traces of the data can be deleted. The data might already be spread through notifications or republished by third-parties. What will be removed is the publication on CODESYS Forge. Subscription to changes on the website A registered user can subscribe on changes of many contents published on this website. If a registered user decides to subscribe to the option, 3S-Smart Software Solutions GmbH will send an email upon change of the content on which the user requested user subscribed. The user can at any time cancel this subscription by visiting the preferences page of his account and clicking on subscriptions. Every notification which is sent to the user upon his subscription is stored. Beside a reference to the user and a reference to the content, which has changes, the specific change of the artifact and the publication date is stored. Changes to our privacy policy We reserve the right to amend our privacy policy from time to time to ensure that it always complies with current legal requirements or to implement changes to our services in the privacy policy. This could concern, for example, the introduction of new services. Each time you visit our website, the data protection provisions that are available online on this website at that time apply. Trademark protection Each trademark or logo mentioned here is the property of the respective company. Trademarks and names are mentioned here purely for informational purposes.
Last updated: 2020-10-22
Migrating Projects
CODESYS Forge
wiki
(WikiPage)
Register a new project SVN import Create package Checkout using cforge Create a package manifest Build package Commit new files Add download link Copy Download Link Add Link Result [[include IndexMain (already included)] Register a new project Select a neighborhood, which fits best for your project and click on "Register a new project". Select the tool SVN. SVN import As a prerequisit, you need to have CODESYS SVN installed. Visit the SVN tool (usually called "Code") on your newly creates project. Then right click on the link "Browse" and copy this link. You can use this link later in CODESYS SVN. Open your library or project file in CODESYS. Click on "Project -> SVN -> Import Project" and import the project to a sub-folder of the repository which you just created. You should use the following folder structure: branches/ tags/ trunk/ PackageName/ LibraryName/ Create package To make your code browsable and create a CODESYS package, that the user can easily install, you should use the tool cforge. Checkout using cforge Visit the SVN tool of your project again. Click on the "Checkout" button. Create a package manifest Right click on the folder, which contains the files of your package Click on cforge -> Create Package Build package Export library as markdown code, and build the package with cforge. Right click on the package folder Click on cforge -> Build The result might look like this: branches/ tags/ trunk/ PackageName.package PackageName/ package.manifest LibraryName.library LibraryName.plcopen.xml LibraryName.md LibraryName/ ... Commit new files Use Tortoise SVN to add the package and mark down files and commit them. Add download link You can add a nice download link for your package to your wiki or blog. Copy Download Link Visit the SVN tool of your project and click on "Browse". Browse to the *.package file and right click on it to copy the link. Add Link Visit your blog or wiki Edit the page Add the link like that... [[download url=https://forge.codesys.com/svn/...]] Result
Last updated: 2018-09-12
Continous Integration
CODESYS Forge
wiki
(WikiPage)
Under development... ...coming soon.
Last updated: 2018-09-22
Developer Community Documentation
CODESYS Forge
community
(WikiPage)
Community Recommended Software CODESYS programming Version Control System Versioning Project versions Versioning of own items A versioning scheme I have used successfully for machines is this: Coding tips Forge Tips Community This documentation is open to be edited by all CODESYS Forge developers. The documentation is intended to share global information, which is of interest for developers of different projects. The contents of the documentation is not meant dogmatic and should provide the reader with enough tips & tricks to help write code which is clearly readable and quicker understood by the community. The developer adhering to these tips & tricks, in return, will reap the benefits in an obvious manner. So, following tips & tricks is strongly encouraged! Software hints Workflows Tutorials Coding tips, - standards or - styles ... Recommended Software CODESYS programming Use the CODESYS programming system in the latest version. It's use is completely free. You can the program every CODESYS programmable PLC with it, or use the 2h Demo of one of the SL runtimes: CODESYS Control Win V3 CODESYS Control for Raspberry Pi SL CODESYS Control for Linux SL The demos are running 2h and can be restarted as often as you want. These can also run demos of fieldbus stacks, which will run for 30m before a restart is needed. Version Control System You should use SVN when you want to have a good version control system with CODESYS projects, and if you want to publish them on CODESYS Forge. CODESYS SVN can be freely used with CODESYS Forge. But we reconnend to use the tool cforge, as it improves the workflow with CODESYS Forge pretty much. CODESYS Git is expected to be available in the next SP. Versioning Project versions When it comes to library compatibility, the rule is really as easy as that: "The CODESYS version of the user should be greater or equal to the format of the library." Things like the compiler version, visu profile, etc. will usually be used from the final project, not from the library. Of course there are some known exceptions; ; ; * etc Versioning of own items The following version scheme suggestion is empirical in nature; v0.0.0.1 Initial version: Your first library / project in beta stage whenever you code or bugfix just arbitrarily count up as you see fit, there is no right or wrong; v0.0.0.2 Bugfixes/coding version 2 .. v0.0.0.49 Bugfixes/coding version 49 etc, etc. whenever you have tested a complete stable internal version; v0.0.1.0 your first stable version (tested) .. v0.0.1.3 your first stable version (tested) with some bugfixes .. v0.0.2.0 your second stable version (tested) .. v0.0.3.11 your third stable version (tested) with more bugfixes etc, etc. whenever you have software which you have tested externally (public beta); v0.1.0.0 your first public beta version (tested/ publicly released) .. v0.1.0.2 your first public beta version (tested/ publicly released) with some bug fixes .. v0.2.0.0 your second public beta version (tested/ publicly released) etc, etc. Whenever you have a stable public alpha release; v1.0.0.0 Your first alpha released version .. v1.0.0.6 Your first alpha released version with some bugfixes .. v1.1.0.9 An alpha released version with a beta tested/released component and some bugfixes .. v2.0.0.0 Your second alpha released version etc, etc. As seen, this versioning scheme leaves "room" for (arbitrarily) smaller or larger code updates while also providing a clear overview of the development progress. Of course, other versioning scheme's are possible (provide examples). A versioning scheme I have used successfully for machines is this: Vx.y.z I will start in the middle as that is the most important, the state. y = 0 = concept (just messing around with an idea) y = 1 = development (goal in mind) y = 2 = released for internal testing (devoloper thinks they are finished and are ready to run through internal testing) y = 3 = released for stakeholder testing (testing complete, ready for testing with eg. Customer or product owner) y = 4 = released for site (this version has all the testing and is ready for site) y = 5 = installed on site (this version is installed on site, but is either not working or hasn't been tested) y = 6 = commissioned (installed on site and somebody (customer?) is satisfied that it is working) Now let's look to the least significant, version z. The first time you enter a new state you are on z=0. Any commits in that state, and z=z+1; Easy right? Now the most significant, version x. The rule is "you cannot go backwards in y without incrementing x." So that is the rules all covered. Now to some nuances or "what about when...". Say you are in V0.3.0 (first stakeholder testing version) and the customer says "I want red to mean on". You do not need to go back to development stage or internal testing. You can simply make the change and commit as "V0.3.1 red now means on", then continue testing. But what if next they said "you completely forgot the intake section of the machine specification!" Perhaps they threw the acceptance test sheets into the air and stormed out of the room. You can probably understand the state (y) may need to go back to development. So, your next commit is V1.1.0. OK, so fast forward to commissioning. It is day 3 of commissioning and you are on V1.5.14. The customer is happy. You now make a commit (with no code changes from V1.5.14) to V1.6.0. The commit message might say something like "customer happy with site test" or even "developer happy the software is working" if that's how you run things. A couple months later the customer asks "can you add an OFF delay to input 3?" You come round, do the change online, customer tests it and says it is fine. Just use V1.6.1 for your next commit. A further 3 months and another small change is asked for. "We would like a trend of input 6." You go in on a down day, make the software change, but there's no product so you can't really test it. Commit the change as V2.5.0 (y=5, increase x by 1, reset z to zero). Two days later you check in with the customer. "All is good". Now you get a new commit, V2.6.0. It is possible to skip steps as well. e.g. If it's decided a Factory Acceptance Test (y=3) isn't needed, go straight to 4. Coding tips when using RTS_IEC_HANDLE and RTS_IEC_RESULT types, please add SysTypes2 Interfaces (3.5.4.0); if possible, use standard error codes (CmpErrors or CmpErrors2 Interfaces); if possible, avoid using dynamic memory (the usage of NEW operator); usage of Structured Text (IEC-ST) language is highly encouraged whenever possible. ST is by far the most versatile and universal language in which all operations manipulations and functions are possible; document the source code, add meaningful comments to it; for modern coding style advice: read the CODESYS v3 library development tips as provided in CODESYS help, The tips and practices laid out in the CODESYS help are pretty complete but not as thorough as Steve McConnell "Code Complete", though they provide a very good starting point. For further reading see e.g. Steve McConnell "Code Complete"; Forge Tips If you want to experiment with markdown syntax, create a project on your profile called "internaltest" and take away permissions of everyone but you. Use the "Create..." button in the top right menu bar for easy access of a wizard for creating and sharing community driven content.
Last updated: 2020-09-16
Following others
CODESYS Forge
wiki
(WikiPage)
User Activity Artifacts [[include IndexMain (already included)] User Activity You can follow other users if you are interested in what they are publishing. Actually you will see only activities on which you have the right to see it. For example, you won't see when someone commits s.th. on a private project. To do so, visit the profile of the person you are interested in, by clicking on his name. Then click on the star above the user activities. Artifacts Artifacts are everything, what is contributed by s.o.: Wiki pages Ticket trackers Blogs Repositories ... You can follow those, by clicking on the "subscribe" link on the top of those pages.
Last updated: 2018-11-01
CODESYS SVN
CODESYS Forge
wiki
(WikiPage)
Free use of CODESYS SVN CODESYS SVN is a comercial extension of CODESYS, which costs some amount of money. But to use it with CODESYS Forge, you can simply download the CODESYS SVN package and install without a license. If the package does not find a license, you get unlimited access to all repositories on CODESYS Forge. All you need is an account on the CODESYS Store, and you can download the most current CODESYS SVN package. [[include IndexMain (already included)]
Last updated: 2020-09-29
Permissions
CODESYS Forge
wiki
(WikiPage)
Groups and Permissions Default Permissions Tickets SVN / Git Blog Wiki Private project [[include IndexMain (already included)] Groups and Permissions On CODESYS Forge you can grant rights on your published data to specific groups of users. There are only two virtual user groups, which you can't change: Authenticated Anonymous Their purpose should be clear - Anonymous identifies all users, who are not logged in, while Authenticated identifies all others. Then there are some more default groups, which you can fill with contacts. Those groups have default rights on specific actions in your project. You can change all of them, but the following tables should give you an overview. Default Permissions Tickets \ Admin Create Ticket Edit Ticket Edit Milestones Delete Tickets Post Comments Moderate Comments Admin + + + + + + + Developer - + + - + + + Authenticated - + - - - + - Anonymous - - - - - - - SVN / Git \ Admin Read Write Admin + + + Developer - + + Authenticated - + - Anonymous - + - Blog \ Admin Create/Edit Post View Posts Post Comments Moderate Comments Admin + + + + + Developer - + + + + Authenticated - - + + - Anonymous - - + - - Wiki \ Admin Edit Pages Delete Pages View Posts Post Comments Moderate Comments Admin + + + + + + Developer - + + + + + Member - + - + + - Authenticated - - - + + - Anonymous - - - + - - Private project Making your project private makes sense, especially when you don't feel ready with it, yet. By default, the projects you post are public, but you can mark them private by taking all normal users the read permissions. To do so, Log In, and go to: Admin ---> User Permissions ... and click on "read" of the section "Anonymous", to deny it. Anonymous Any user including those not logged in read admin create update
Last updated: 2019-06-19
Discussions
CODESYS Forge
wiki
(WikiPage)
Artifacts Threads Rating [[include IndexMain (already included)] Artifacts In a software forge, it is important to be able to discuss everything. CODESYS Forge supports discussions on a big range of artifacts, like wiki pages, tickets,... Threads Discusssions threads are ordered in a tree model. So you can always have parallel discussions on the same topics, and you always know which previous posts, one is referencing. Rating You can rate specific discussion posts up or down. The different main discussion threads are ordered, based on this rating. So you can push good posts further up.
Last updated: 2019-06-28
Licensing
CODESYS Forge
wiki
(WikiPage)
Choose a license Allowed licenses [[include IndexMain (already included)] Choose a license If you are new to open source software licensing, choosing the right license for your situation and your requirements, can become a quite difficult task. There is a nice website, called choosealicense.com. This site might give you the best background informations about the available licenses. Our best advise should be: Choose a well known and approved license, which you fully understand and agree with. Allowed licenses On CODESYS Forge we allow you to choose the license which fits best for you. But you might notice, that some licenses are marked red, while others are marked blue. The reason is, that we recommend two licenses, which we find are least critical for the users who download your software: MIT Unlicense With this measure, we don't want to criticize all other licenses out there. But most of them pass additional requirements on to the users, which the user has to be aware of. Just give credits for the work that you used in your own project, and you are already fine. Therefore we mark projects using those licenses specially.
Last updated: 2020-06-08