Skip to content

Commit

Permalink
Disabled auto deploy to gateway, as it tends to make the build look l…
Browse files Browse the repository at this point in the history
…ike it failed. Also added example summaries to README.md
  • Loading branch information
grossm04 authored and kevinherron committed Sep 13, 2018
1 parent 12fc749 commit b337f8f
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,10 @@ target/*
# Mercurial #
.hg
.hgignore

# Eclipse #
org.eclipse.jdt.core.prefs
org.eclipse.m2e.core.prefs
org.eclipse.core.resources.prefs
.classpath
.project
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,40 @@
# Ignition SDK

## Summary of Example Modules
**AbstractTagDriverExample**
Creates an example device in the Gateway. The device will create tags that are visible under the local OPC-UA server.

**ComponentExample**
Creates a Hello World component that can be dragged onto a window in the Designer.

**expression-example**
Creates an exampleMultiply expression that can be used by other components, such as expression tags. The example expression is located under the Extended expression category.

**gateway-network-example**
Requires two Gateways connected via the gateway network. The module must also be installed on both Gateways. This module adds a system.example.getRemoteLogEntries script function that can retrieve console log entries from a remote Gateway over the gateway network. Also adds a Gateway Task type that can retrieve a remote gateway’s wrapper log and save as a local file.

**home-connect-example**
Demonstrates how to implement Gateway Status and Config pages. HomeConnect pages are added to the Gateway that configure an imaginary HomeConnect device.

**ModbusDriverExample**
A module that provides a fully functional Modbus TCP driver.

**NotificationExample**
Adds a Console Alarm Notification type that handles alarm notifications via log messages in the console.

**report-component**
Adds a Smiley shaped component to the Report Designer.

**report-datasource-example**
Adds a datasource to the report designer that can retrieve JSON data via a REST call to a website.

**scripting-rpc-example**
Adds a system.example.multiply script that can be executed from both a client and a Gateway. Also demonstrates how the client can call a method in the Gateway via RPC.

**SimpleTagProviderExample**
Adds a DynamicTags tag provider, which includes tags that are updated every second by the module.


## Getting Started

1. You will need the Java JDK 1.8+ installed, downloadable from the [Java SDK Downloads](http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html) page.
Expand Down
2 changes: 2 additions & 0 deletions gateway-network-example/get-remote-logs-build/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,15 @@
</execution>

<!-- Auto-installs module in Gateway, requires a cd-key with developer mode enabled -->
<!--
<execution>
<id>install-modl</id>
<phase>install</phase>
<goals>
<goal>post</goal>
</goals>
</execution>
-->
</executions>

<configuration>
Expand Down
3 changes: 3 additions & 0 deletions home-connect-example/hce-build/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
<goal>modl</goal>
</goals>
</execution>
<!-- Auto-installs module in Gateway, requires a cd-key with developer mode enabled -->
<!--
<execution>
<id>post-module</id>
<phase>install</phase>
Expand All @@ -44,6 +46,7 @@
<goal>post</goal>
</goals>
</execution>
-->
</executions>

<configuration>
Expand Down
3 changes: 3 additions & 0 deletions report-component/build/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,16 @@
<goal>modl</goal>
</goals>
</execution>
<!-- Auto-installs module in Gateway, requires a cd-key with developer mode enabled -->
<!--
<execution>
<id>post</id>
<phase>install</phase>
<goals>
<goal>post</goal>
</goals>
</execution>
-->
</executions>

<!-- configure which scopes each of our maven modules should be associated with -->
Expand Down
3 changes: 3 additions & 0 deletions report-datasource-example/build/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,16 @@
<goal>modl</goal>
</goals>
</execution>
<!-- Auto-installs module in Gateway, requires a cd-key with developer mode enabled -->
<!--
<execution>
<id>post</id>
<phase>install</phase>
<goals>
<goal>post</goal>
</goals>
</execution>
-->
</executions>

<!-- configure which scopes each of our maven modules should be associated with -->
Expand Down
3 changes: 3 additions & 0 deletions scripting-rpc-example/scripting-rpc-build/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,16 @@
<goal>modl</goal>
</goals>
</execution>
<!-- Auto-installs module in Gateway, requires a cd-key with developer mode enabled -->
<!--
<execution>
<id>install-modl</id>
<phase>install</phase>
<goals>
<goal>post</goal>
</goals>
</execution>
-->
</executions>

<configuration>
Expand Down

0 comments on commit b337f8f

Please sign in to comment.