Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 2.85 KB

readme.md

File metadata and controls

35 lines (19 loc) · 2.85 KB
Raw

Ignition SDK

Example Modules

Gradle Examples

The Module Build System

These examples utilize Gradle and our Gradle Plugin. Gradle is mature and capable, offering different tradeoffs in terms of performance, ease of customization, language support, etc. If you prefer XML configuration, take a look at Maven. If you prefer declarative programming-language based configuration, check out Gradle. Inductive Automation uses Gradle to build Ignition and our own modules with the same open source plugin linked above.

The Gradle Plugin is published to the Gradle Plugin Portal, and may be used simply by applying the plugin to your gradle project.

General Requirements

These requirements generally apply to Gradle build tools.

  • Java Development Kit (JDK) 11 installed. You can download it on the Java SDK Downloads page. Licensed/TCK tested JDK vendors such as Adoptium, Azul Zulu, etc, are generally suitable JDKs as well.
  • A running, 8.0+ version of Ignition to test your module in. If you don't already have Ignition installed head to the Inductive Automation downloads page, download the correct package for your system and follow the installation instructions to get a gateway up and running.
  • For development convenience, you may want to allow unsigned modules. Open the ignition.conf file in the data/ directory, then in the wrapper.java.additional section add a line like: wrapper.java.additional.7=-Dignition.allowunsignedmodules=true (the index does not matter).

Getting Started

  • Once you have configured your developer gateway, make sure git is installed and clone this repo to a directory of your choice: git clone https://github.com/inductiveautomation/ignition-sdk-training.git

  • Using your IDE of choice, you should be able to create or open any of these included Example Modules through the settings.gradle.kts, file located in the root of each example. Upon importing this project into your IDE, it should download (if auto-import is on) necessary dependencies from the Inductive Automation artifact repository. Dependencies are managed through Maven and are cached to your local environment after they are downloaded.

Running Gradle Examples

For instructions on how to build with the Gradle plugin, take a look at the documentation on the Gradle Plugin repository.

Javadocs

Head over to our wiki page for a listing of 8.0+ javadocs.