Skip to content

Twinpack is a package manager for TwinCAT libraries with integration into the TwinCAT IDE. It enables the TwinCAT community to share their libraries and simplifies the continous integration of third-party components into TwinCAT projects.

License

Notifications You must be signed in to change notification settings

Zeugwerk/Twinpack

Repository files navigation

Twinpack

The Twinpack Package Manager is a powerful and user-friendly package management tool for TwinCAT libraries. It is designed to empower the TwinCAT community by enabling sharing and distribution of libraries. It acts as a versatile platform similarly to NuGet (but with a PLC touch), allowing users to efficiently manage and deploy their custom-built modules.

Quicklinks

Installation

To use the Twinpack Package Manager, follow these steps:

  1. Download the latest installer.
  2. Select the IDEs, which Twinpack should be installed for.
  3. Click on "Install".
  4. Follow the on-screen instructions to complete the installation.

Using a Package

To install a package, follow these steps:

  1. Open a TwinCAT solution and navigate to a PLC.
  2. Right click the References item of your PLC
  3. Click Twinpack Catalog...
  4. Browse or search for the desired package.
  5. Click on the package to view details.
  6. Click on the Add to install this package and add it to the referenced libraries.
  7. Wait for the installation process to complete. If you are installing packages from a contributor for the first time and these packages come with a license you will be asked to confirm their license agreement in order to advance.
  8. Twinpack automatically installs the package, including all depending libraries, on your System and adds it as a reference to your PLC.
  9. Follow the library documentation or instructions to incorporate its functionality into your project.

Connect to Beckhoff and/or custom package servers

Twinpack supports the NuGet protocol for packages, including repositories hosted by Beckhoff since TwinCAT 4026.xx. Follow these steps to add a new repository to Twinpack:

  1. Click Configure at the top right of the Twinpack Catalog to open the configuration window.
  2. Click Add to add new package servers.
  3. Configure each new package server by:
    • Entering the URL of the package server.
    • Giving it a name of your choice.
    • Selecting the type of package server from the combo box.
  4. Depending on the server configuration, you may need to Login with your credentials for the respective repository.
  5. Click OK to save your configuration. The Twinpack catalog will reload and display packages from your additional package servers.

URLs to popular repositories:

  • Official Twinpack Repository (preconfigured): https://twinpack.dev. Log in is optional. However, logging in will display your private packages and/or packages that are licensed to you by Zeugwerk. If you forgot your Twinpack login, reset it here.
  • Public Beckhoff Repository: https://public.tcpkg.beckhoff-cloud.com/api/v1/feeds/stable, log in in is mandatory. Use your Beckhoff credentials to connect. If you don't have a Beckhoff login, register here.

Share a Package ...

There are multiple ways to publish a package on Twinpack and you can chose how you want to publish your packages depending on how you want to create releases.

with the Twinpack Registry

The most straight forward way to publish a package, which you release on GitHub anyway, is to use the Twinpack Registry.

  • Create a Pull Request in which you add your repository to the repositories.txt file, similarily to this commit.
  • No other action is needed, there is a workflow in the twinpack-registry repository, which automatically uploads all libraries found in the latest release for all repositories on this list.

with a GitHub workflow

If you have a CI/CD environment it can be benefical to you to upload your package by using the Twinpack Commandline interface (see the TwinpackCli project in Twinpack). For GitHub, we tried to streamline this process as much as possible by providing a GitHub action, which will do this for you, see twinpack-action for details.

Note, if you don't have your own CI/CD environment, this action can be used to implement CI/CD on the Zeugwerk CI/CD environment, unlike Twinpack we can only provide this environment free of charge in a limited amount (at the moment 30 buildactions / month)

manually in your IDE

This is the most straight forward way to publish a package if you want to publish your library directly from your IDE

  1. Open a TwinCAT solution and navigate to the PLC library you want to share with the community.
  2. Right click the PLC item and click Twinpack -> Publish ...
  3. In the dialog, which opens, fill in the information describing your package.
    • Distributor (mandatory): The name you enter here will be exclusively associated with your Twinpack Account, and it will serve as a unique identifier for all your upcoming packages.
    • Version (mandatory): This is the initial version of your package. Once you publish your package for the first time, you have the flexibility to release newer versions in the future.
    • Other fields are optional
  4. Click publish to make Twinpack
    • Check all objects of your library
    • Upload the library as a package to the Twinpack server making it available for the community

After the initial upload of your library as a package, you may publish newer versions of your library or you can also modify the current version by right clicking on the PLC item and then on Twinpack -> Modify.... Users of Twinpack will be notified whenever a newer version is available in the Twinpack Catalog.

Further information

🌟 Make sure to follow this project by leaving a star or simply follow us, to always get notified if a newer version of Twinpack is released.

📺 We have also created a short introductionary video on how to install and use Twinpack

About

Twinpack is a package manager for TwinCAT libraries with integration into the TwinCAT IDE. It enables the TwinCAT community to share their libraries and simplifies the continous integration of third-party components into TwinCAT projects.

Topics

Resources

License

Stars

Watchers

Forks

Packages