Skip to content

Latest commit

 

History

History
241 lines (161 loc) · 7.6 KB

README.md

File metadata and controls

241 lines (161 loc) · 7.6 KB

Ignition SDK Installation and Setup

Quick Start With ArcheTypes

You must have Maven installed before you can complete this guide.

In a command prompt 'change directory' to the location you wish to store your modules, type the following command:

mvn archetype:generate

You will be presented with an option "Choose a number or apply filter".

Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains):

Type the following filter:

client-designer-gateway-archetype

You will be presented the option.

1: remote -> com.inductiveautomation.ignitionsdk:client-designer-gateway-archetype

Simply choose an option:
The only current option:

1

You will then be asked to choose a version.

Choose com.inductiveautomation.ignitionsdk:client-designer-gateway-archetype version
1: 1.0.1
2: 1.0.2
3: 1.0.3
4: 1.1.0

Simply pick the version you want ( Most likely option 4, the current latest version )

4

After these options you will be required to define the module you are planning to create.

This example will create the module com.companyname.category.testing version 1.0.0.
Note: I chose to opt-out of doing SNAPSHOT's

Define value for property 'groupId': com.companyname.category
Define value for property 'artifactId': testing
Define value for property 'version' 1.0-SNAPSHOT: : 1.0.0
Define value for property 'package' com.steritec.modules: : (I Left Blank)

Confirm properties configuration:
groupId: com.steritec.modules
artifactId: testing
version: 1.0.0
package: com.steritec.modules
Y: Y


After confirming the configuration setup you should have the correct structure to get started.

Change directory to the "ArtifactID"
Note: The ArtifactID from the example above was named "testing"

cd testing

I will share how I prefer to open the project for the first time. Of course there are many ways, however.

In the same CMD prompt, after the steps above, I type:

explorer .

This will open the current directory in the windows explorer. From this folder, locate the "pom.xml" file. Right click on the file and Open With -> (Your IDE of Choice) I.E. Intellij (If you do not see the IDE in the list you may have to choose to view more apps to locate it.)

This will load the project along with it's dependencies.

Continue on for more goodies...

JAVA DOCS

Setup Java Docs

At the time of writing this.. The archetype generated from the instructions above will produce a POM.xml that references older repository URLs.
If they are already changed in the pom.xml file you can skip this part. I will attempt to walk you through this fix now.

In the root directory of your module, open the "pom.xml" file.

Change all URL's in the "pluginRepositories" and "repositories" sections:

FROM:
    http://nexus.inductiveautomation.com:8081/content/repositories/<repo name>
TO:
    https://nexus.inductiveautomation.com/repository/<repo name>

Example:

FROM:
    <url>http://nexus.inductiveautomation.com:8081/content/repositories/inductiveautomation-releases</url>

TO:
    <url>https://nexus.inductiveautomation.com/repository/inductiveautomation-releases</url>

Save the file and finally, resolve java docs via maven:

mvn dependency:resolve -Dclassifier=javadoc

MODULE INSTALLING

Setup Module Installing

Make sure you have changed the repository URL's from the above "Java Docs" section before continuing.

In order to install your module quickly and without signing you need to do the following:

Open Start Menu -> type: notepad -> right click it and 'Run as administrator'

Opening this way because the Gateway may be running and won't let you save changes otherwise.

Inside Notepad, Click File -> Open and browse to the Ignition "data" folder

Possible directory location:

C:\Program Files\Inductive Automation\Ignition\data\ignition.config

Note: If you do not see the file 'ignition.config'
Try changing the file extension filter from "Text Documents (.txt)" to "All Files (.)"

Find and Select -> ignition.config -> Click "Open"

Find the section marked:

#********************************************************************
# Wrapper Java Properties
#********************************************************************

Find the subsection marked:

# Java Additional Parameters

Add the following two lines to the bottom of that section:

wrapper.java.additional.7=-Dignition.allowunsignedmodules=true
wrapper.java.additional.11=-Dia.developer.moduleupload=true

Save the file:

File -> Save

We now need to add the execution to the pom.xml file located in the newly created "[artifactId]-build" folder:
Should look like this:

        <executions>
            <execution>
                <phase>package</phase>
                <goals>
                    <goal>modl</goal>
                </goals>
            </execution>
            <execution>
                <id>post-module</id>
                <phase>install</phase>
                <goals>
                    <goal>modl</goal>
                    <goal>post</goal>
                </goals>
            </execution>
        </executions>

This will allow you to install your package to the gateway via the following command:

mvn install

Some Extra Notes:
- This will both package and install your module.
- If you're writing a gateway module, you may need to restart gateway.
- You can do this through the "Gateway Control Utility".