├── .gitignore ├── LICENSE ├── README.md ├── client-designer-gateway-archetype ├── pom.xml └── src │ └── main │ └── resources │ ├── META-INF │ └── maven │ │ ├── archetype-metadata.xml │ │ └── archetype.xml │ └── archetype-resources │ ├── __rootArtifactId__-build │ └── pom.xml │ ├── __rootArtifactId__-client │ ├── pom.xml │ └── src │ │ └── main │ │ └── java │ │ └── client │ │ └── ClientHook.java │ ├── __rootArtifactId__-common │ └── pom.xml │ ├── __rootArtifactId__-designer │ ├── pom.xml │ └── src │ │ └── main │ │ └── java │ │ └── designer │ │ └── DesignerHook.java │ ├── __rootArtifactId__-gateway │ ├── pom.xml │ └── src │ │ └── main │ │ └── java │ │ └── GatewayHook.java │ └── pom.xml ├── opc-ua-device-archetype ├── pom.xml └── src │ └── main │ └── resources │ ├── META-INF │ └── maven │ │ ├── archetype-metadata.xml │ │ └── archetype.xml │ └── archetype-resources │ ├── __rootArtifactId__-build │ └── pom.xml │ ├── __rootArtifactId__-device │ ├── pom.xml │ └── src │ │ └── main │ │ └── java │ │ └── ModuleHook.java │ └── pom.xml ├── pom.xml └── vision-component-archetype ├── pom.xml └── src └── main └── resources ├── META-INF └── maven │ ├── archetype-metadata.xml │ └── archetype.xml └── archetype-resources ├── __rootArtifactId__-build └── pom.xml ├── __rootArtifactId__-client ├── pom.xml └── src │ └── main │ └── java │ └── client │ └── HelloWorldComponent.java ├── __rootArtifactId__-designer ├── pom.xml └── src │ └── main │ └── java │ └── designer │ ├── DesignerHook.java │ └── beaninfos │ └── HelloWorldComponentBeanInfo.java └── pom.xml /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | 3 | # Package Files # 4 | *.jar 5 | *.war 6 | *.ear 7 | 8 | # IntelliJ # 9 | *.iml 10 | .idea/* 11 | 12 | # Maven # 13 | **/target/* 14 | target/* 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Ignition SDK Maven Archetypes 2 | Maven archetypes for generating various Ignition module skeleton projects. 3 | 4 | ### Client + Designer + Gateway Module 5 | A module that will load hooks into all three scopes. 6 | 7 | ``` 8 | mvn archetype:generate \ 9 | -DarchetypeGroupId=com.inductiveautomation.ignitionsdk \ 10 | -DarchetypeArtifactId=client-designer-gateway-archetype \ 11 | -DarchetypeVersion=1.2.0 12 | ``` 13 | 14 | ### OPC UA Device Module 15 | A module that will provide a new device type for Ignition's OPC UA server. 16 | 17 | ``` 18 | mvn archetype:generate \ 19 | -DarchetypeGroupId=com.inductiveautomation.ignitionsdk \ 20 | -DarchetypeArtifactId=opc-ua-device-archetype \ 21 | -DarchetypeVersion=1.2.0 22 | ``` 23 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 6 | com.inductiveautomation.ignitionsdk 7 | ignition-sdk-archetypes 8 | 1.2.1-SNAPSHOT 9 | 10 | 11 | client-designer-gateway-archetype 12 | maven-archetype 13 | 14 | Archetype - Ignition Client+Designer+Gateway Scope Module 15 | Maven Archetype for an Ignition Client+Designer+Gateway Scope Module 16 | http://github.com/inductiveautomation/ignition-sdk-archetypes 17 | 18 | 19 | 20 | 21 | org.apache.maven.archetype 22 | archetype-packaging 23 | 2.3 24 | 25 | 26 | 27 | 28 | 29 | 30 | maven-archetype-plugin 31 | 2.3 32 | 33 | 34 | 35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | src/main/java 10 | 11 | 12 | src/main/resources 13 | 14 | 15 | 16 | 17 | 18 | 19 | src/main/java 20 | 21 | 22 | src/main/resources 23 | 24 | 25 | 26 | 27 | 28 | 29 | src/main/java 30 | 31 | 32 | src/main/resources 33 | 34 | 35 | 36 | 37 | 38 | 39 | src/main/java 40 | 41 | 42 | src/main/resources 43 | 44 | 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/META-INF/maven/archetype.xml: -------------------------------------------------------------------------------- 1 | 2 | client-designer-gateway-archetype 3 | 4 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/archetype-resources/__rootArtifactId__-build/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${rootArtifactId} 9 | ${groupId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | ${groupId} 18 | ${rootArtifactId}-client 19 | ${version} 20 | 21 | 22 | ${groupId} 23 | ${rootArtifactId}-common 24 | ${version} 25 | 26 | 27 | ${groupId} 28 | ${rootArtifactId}-designer 29 | ${version} 30 | 31 | 32 | ${groupId} 33 | ${rootArtifactId}-gateway 34 | ${version} 35 | 36 | 37 | 38 | 39 | 40 | 41 | com.inductiveautomation.ignitionsdk 42 | ignition-maven-plugin 43 | 1.2.0 44 | 45 | 46 | 47 | package-modl 48 | package 49 | 50 | modl 51 | 52 | 53 | 54 | install-modl 55 | install 56 | 57 | post 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | ${rootArtifactId}-client 66 | C 67 | 68 | 69 | ${rootArtifactId}-common 70 | CDG 71 | 72 | 73 | ${rootArtifactId}-designer 74 | CD 75 | 76 | 77 | ${rootArtifactId}-gateway 78 | G 79 | 80 | 81 | 82 | ${groupId}.${rootArtifactId} 83 | ${project.parent.name} 84 | ${project.description} 85 | ${version} 86 | 8.1.33 87 | 88 | 89 | 90 | C 91 | ${package}.client.ClientHook 92 | 93 | 94 | D 95 | ${package}.designer.DesignerHook 96 | 97 | 98 | G 99 | ${package}.GatewayHook 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/archetype-resources/__rootArtifactId__-client/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${rootArtifactId} 9 | ${groupId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | ${groupId} 18 | ${rootArtifactId}-common 19 | ${version} 20 | 21 | 22 | 23 | com.inductiveautomation.ignitionsdk 24 | ignition-common 25 | ${ignition-sdk-version} 26 | pom 27 | provided 28 | 29 | 30 | 31 | com.inductiveautomation.ignitionsdk 32 | client-api 33 | ${ignition-sdk-version} 34 | pom 35 | provided 36 | 37 | 38 | 39 | com.inductiveautomation.ignitionsdk 40 | designer-api 41 | ${ignition-sdk-version} 42 | pom 43 | provided 44 | 45 | 46 | 47 | com.inductiveautomation.ignitionsdk 48 | vision-designer-api 49 | ${ignition-sdk-version} 50 | pom 51 | provided 52 | 53 | 54 | 55 | com.inductiveautomation.ignitionsdk 56 | vision-client-api 57 | ${ignition-sdk-version} 58 | pom 59 | provided 60 | 61 | 62 | 63 | 64 | 65 | 66 | org.apache.maven.plugins 67 | maven-compiler-plugin 68 | 3.2 69 | 70 | 17 71 | 17 72 | 73 | 74 | 75 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/archetype-resources/__rootArtifactId__-client/src/main/java/client/ClientHook.java: -------------------------------------------------------------------------------- 1 | package ${package}.client; 2 | 3 | import com.inductiveautomation.ignition.client.model.ClientContext; 4 | import com.inductiveautomation.ignition.common.licensing.LicenseState; 5 | import com.inductiveautomation.vision.api.client.AbstractClientModuleHook; 6 | import com.inductiveautomation.ignition.common.util.LoggerEx; 7 | 8 | public class ClientHook extends AbstractClientModuleHook { 9 | 10 | private final LoggerEx logger = LoggerEx.newBuilder().build(getClass()); 11 | 12 | @Override 13 | public void startup(ClientContext context, LicenseState activationState) throws Exception { 14 | super.startup(context, activationState); 15 | } 16 | 17 | @Override 18 | public void shutdown() { 19 | super.shutdown(); 20 | } 21 | 22 | } 23 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/archetype-resources/__rootArtifactId__-common/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${rootArtifactId} 9 | ${groupId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | com.inductiveautomation.ignitionsdk 18 | ignition-common 19 | ${ignition-sdk-version} 20 | pom 21 | provided 22 | 23 | 24 | 25 | 26 | 27 | 28 | org.apache.maven.plugins 29 | maven-compiler-plugin 30 | 3.2 31 | 32 | 17 33 | 17 34 | 35 | 36 | 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/archetype-resources/__rootArtifactId__-designer/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${rootArtifactId} 9 | ${groupId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | ${groupId} 18 | ${rootArtifactId}-client 19 | ${version} 20 | 21 | 22 | ${groupId} 23 | ${rootArtifactId}-common 24 | ${version} 25 | 26 | 27 | 28 | com.inductiveautomation.ignitionsdk 29 | ignition-common 30 | ${ignition-sdk-version} 31 | pom 32 | provided 33 | 34 | 35 | 36 | com.inductiveautomation.ignitionsdk 37 | client-api 38 | ${ignition-sdk-version} 39 | pom 40 | provided 41 | 42 | 43 | 44 | com.inductiveautomation.ignitionsdk 45 | designer-api 46 | ${ignition-sdk-version} 47 | pom 48 | provided 49 | 50 | 51 | 52 | com.inductiveautomation.ignitionsdk 53 | vision-designer-api 54 | ${ignition-sdk-version} 55 | pom 56 | provided 57 | 58 | 59 | 60 | 61 | 62 | 63 | org.apache.maven.plugins 64 | maven-compiler-plugin 65 | 3.2 66 | 67 | 17 68 | 17 69 | 70 | 71 | 72 | 73 | 74 | 75 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/archetype-resources/__rootArtifactId__-designer/src/main/java/designer/DesignerHook.java: -------------------------------------------------------------------------------- 1 | package ${package}.designer; 2 | 3 | import com.inductiveautomation.ignition.common.licensing.LicenseState; 4 | import com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook; 5 | import com.inductiveautomation.ignition.designer.model.DesignerContext; 6 | import com.inductiveautomation.ignition.common.util.LoggerEx; 7 | 8 | public class DesignerHook extends AbstractDesignerModuleHook { 9 | 10 | private final LoggerEx logger = LoggerEx.newBuilder().build(getClass()); 11 | 12 | @Override 13 | public void startup(DesignerContext context, LicenseState activationState) throws Exception { 14 | super.startup(context, activationState); 15 | } 16 | 17 | @Override 18 | public void shutdown() { 19 | super.shutdown(); 20 | } 21 | 22 | } 23 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/archetype-resources/__rootArtifactId__-gateway/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${rootArtifactId} 9 | ${groupId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | com.inductiveautomation.ignitionsdk 18 | ignition-common 19 | ${ignition-sdk-version} 20 | pom 21 | provided 22 | 23 | 24 | 25 | com.inductiveautomation.ignitionsdk 26 | gateway-api 27 | ${ignition-sdk-version} 28 | pom 29 | provided 30 | 31 | 32 | 33 | 34 | 35 | 36 | org.apache.maven.plugins 37 | maven-compiler-plugin 38 | 3.2 39 | 40 | 17 41 | 17 42 | 43 | 44 | 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/archetype-resources/__rootArtifactId__-gateway/src/main/java/GatewayHook.java: -------------------------------------------------------------------------------- 1 | package ${package}; 2 | 3 | import com.inductiveautomation.ignition.common.licensing.LicenseState; 4 | import com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook; 5 | import com.inductiveautomation.ignition.gateway.model.GatewayContext; 6 | import com.inductiveautomation.ignition.common.util.LoggerEx; 7 | 8 | public class GatewayHook extends AbstractGatewayModuleHook { 9 | 10 | private final LoggerEx logger = LoggerEx.newBuilder().build(getClass()); 11 | 12 | @Override 13 | public void setup(GatewayContext gatewayContext) { 14 | 15 | } 16 | 17 | @Override 18 | public void startup(LicenseState licenseState) { 19 | 20 | } 21 | 22 | @Override 23 | public void shutdown() { 24 | 25 | } 26 | 27 | } 28 | -------------------------------------------------------------------------------- /client-designer-gateway-archetype/src/main/resources/archetype-resources/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | ${groupId} 8 | ${artifactId} 9 | ${version} 10 | pom 11 | 12 | ${rootArtifactId} Ignition Module 13 | ${rootArtifactId} Ignition Module 14 | 15 | 16 | 8.1.33 17 | 18 | 19 | 20 | ${rootArtifactId}-build 21 | ${rootArtifactId}-client 22 | ${rootArtifactId}-common 23 | ${rootArtifactId}-designer 24 | ${rootArtifactId}-gateway 25 | 26 | 27 | 28 | 29 | releases 30 | https://nexus.inductiveautomation.com/repository/inductiveautomation-releases 31 | 32 | true 33 | always 34 | 35 | 36 | false 37 | 38 | 39 | 40 | 41 | 42 | 43 | releases 44 | https://nexus.inductiveautomation.com/repository/inductiveautomation-releases 45 | 46 | false 47 | 48 | 49 | true 50 | always 51 | 52 | 53 | 54 | 55 | snapshots 56 | https://nexus.inductiveautomation.com/repository/inductiveautomation-snapshots 57 | 58 | true 59 | always 60 | 61 | 62 | false 63 | 64 | 65 | 66 | 67 | thirdparty 68 | https://nexus.inductiveautomation.com/repository/inductiveautomation-thirdparty 69 | 70 | true 71 | always 72 | 73 | 74 | false 75 | 76 | 77 | 78 | 79 | 80 | -------------------------------------------------------------------------------- /opc-ua-device-archetype/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 6 | com.inductiveautomation.ignitionsdk 7 | ignition-sdk-archetypes 8 | 1.2.1-SNAPSHOT 9 | 10 | 11 | opc-ua-device-archetype 12 | maven-archetype 13 | 14 | Archetype - Ignition OPC UA Device Module 15 | Maven Archetype for an Ignition OPC UA Device Module 16 | http://github.com/inductiveautomation/ignition-sdk-archetypes 17 | 18 | 19 | 20 | 21 | org.apache.maven.archetype 22 | archetype-packaging 23 | 2.3 24 | 25 | 26 | 27 | 28 | 29 | 30 | maven-archetype-plugin 31 | 2.3 32 | 33 | 34 | 35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /opc-ua-device-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | src/main/java 11 | 12 | 13 | src/main/resources 14 | 15 | 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /opc-ua-device-archetype/src/main/resources/META-INF/maven/archetype.xml: -------------------------------------------------------------------------------- 1 | 2 | opc-ua-device-archetype 3 | 4 | -------------------------------------------------------------------------------- /opc-ua-device-archetype/src/main/resources/archetype-resources/__rootArtifactId__-build/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${groupId} 9 | ${rootArtifactId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | ${groupId} 18 | ${rootArtifactId}-device 19 | ${version} 20 | 21 | 22 | 23 | 24 | 25 | 26 | com.inductiveautomation.ignitionsdk 27 | ignition-maven-plugin 28 | 1.2.0 29 | 30 | 31 | 32 | package 33 | 34 | modl 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | ${rootArtifactId}-device 43 | G 44 | 45 | 46 | 47 | ${groupId}.${rootArtifactId} 48 | ${project.parent.name} 49 | ${project.description} 50 | ${version} 51 | 8.1.33 52 | 53 | 54 | 55 | G 56 | ${package}.ModuleHook 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | -------------------------------------------------------------------------------- /opc-ua-device-archetype/src/main/resources/archetype-resources/__rootArtifactId__-device/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${groupId} 9 | ${rootArtifactId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | com.inductiveautomation.ignitionsdk 18 | ignition-common 19 | ${ignition-sdk-version} 20 | pom 21 | provided 22 | 23 | 24 | 25 | com.inductiveautomation.ignitionsdk 26 | gateway-api 27 | ${ignition-sdk-version} 28 | pom 29 | provided 30 | 31 | 32 | 33 | com.inductiveautomation.ignitionsdk 34 | driver-api 35 | ${ignition-sdk-version} 36 | pom 37 | provided 38 | 39 | 40 | 41 | 42 | 43 | 44 | org.apache.maven.plugins 45 | maven-compiler-plugin 46 | 3.2 47 | 48 | 17 49 | 17 50 | 51 | 52 | 53 | 54 | 55 | 56 | -------------------------------------------------------------------------------- /opc-ua-device-archetype/src/main/resources/archetype-resources/__rootArtifactId__-device/src/main/java/ModuleHook.java: -------------------------------------------------------------------------------- 1 | package ${package}; 2 | 3 | import java.util.Collections; 4 | import java.util.List; 5 | import javax.annotation.Nonnull; 6 | 7 | import com.inductiveautomation.ignition.common.licensing.LicenseState; 8 | import com.inductiveautomation.ignition.gateway.model.GatewayContext; 9 | import com.inductiveautomation.ignition.gateway.opcua.server.api.AbstractDeviceModuleHook; 10 | import com.inductiveautomation.ignition.gateway.opcua.server.api.DeviceType; 11 | import org.jetbrains.annotations.NotNull; 12 | 13 | 14 | public class ModuleHook extends AbstractDeviceModuleHook { 15 | 16 | @Override 17 | public void setup(@NotNull GatewayContext context) { 18 | super.setup(context); 19 | 20 | // TODO add something to BundleUtil? 21 | } 22 | 23 | @Override 24 | public void startup(@NotNull LicenseState activationState) { 25 | super.startup(activationState); 26 | 27 | // TODO startup stuff? 28 | } 29 | 30 | @Override 31 | public void shutdown() { 32 | super.shutdown(); 33 | 34 | // TODO remove something from BundleUtil? 35 | } 36 | 37 | @Nonnull 38 | @Override 39 | protected List getDeviceTypes() { 40 | // TODO return a non-empty list 41 | 42 | return Collections.emptyList(); 43 | } 44 | 45 | } 46 | -------------------------------------------------------------------------------- /opc-ua-device-archetype/src/main/resources/archetype-resources/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | ${groupId} 8 | ${artifactId} 9 | ${version} 10 | pom 11 | 12 | ${rootArtifactId} Device Module 13 | ${rootArtifactId} Device Module 14 | 15 | 16 | 8.1.33 17 | 18 | 19 | 20 | ${rootArtifactId}-build 21 | ${rootArtifactId}-device 22 | 23 | 24 | 25 | 26 | releases 27 | https://nexus.inductiveautomation.com/repository/inductiveautomation-releases 28 | 29 | true 30 | always 31 | 32 | 33 | false 34 | 35 | 36 | 37 | 38 | 39 | 40 | releases 41 | https://nexus.inductiveautomation.com/repository/inductiveautomation-releases 42 | 43 | false 44 | 45 | 46 | true 47 | always 48 | 49 | 50 | 51 | 52 | snapshots 53 | https://nexus.inductiveautomation.com/repository/inductiveautomation-snapshots 54 | 55 | true 56 | always 57 | 58 | 59 | false 60 | 61 | 62 | 63 | 64 | thirdparty 65 | https://nexus.inductiveautomation.com/repository/inductiveautomation-thirdparty 66 | 67 | true 68 | always 69 | 70 | 71 | false 72 | 73 | 74 | 75 | 76 | 77 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | com.inductiveautomation.ignitionsdk 6 | ignition-sdk-archetypes 7 | 1.2.1-SNAPSHOT 8 | pom 9 | 10 | Ignition SDK Archetypes 11 | Maven Archetypes for the Ignition SDK 12 | http://github.com/inductiveautomation/ignition-sdk-archetypes 13 | 14 | 15 | client-designer-gateway-archetype 16 | opc-ua-device-archetype 17 | vision-component-archetype 18 | 19 | 20 | 21 | https://github.com/inductiveautomation/ignition-sdk-archetypes 22 | scm:git:git://github.com/inductiveautomation/ignition-sdk-archetypes.git 23 | 24 | scm:git:git@github.com:inductiveautomation/ignition-sdk-archetypes.git 25 | 26 | HEAD 27 | 28 | 29 | 30 | 31 | Apache License, Version 2.0 32 | http://www.apache.org/licenses/LICENSE-2.0.txt 33 | repo 34 | 35 | 36 | 37 | 38 | github 39 | http://github.com/inductiveautomation/ignition-sdk-archetypes/issues 40 | 41 | 42 | 43 | 44 | Kevin Herron 45 | kevin@inductiveautomation.com 46 | 47 | 48 | 49 | 50 | true 51 | 3.0 52 | 17 53 | 17 54 | UTF-8 55 | ${encoding} 56 | 57 | 58 | 59 | ${maven.version} 60 | 61 | 62 | 63 | 64 | ossrh-release 65 | 66 | 67 | 68 | org.apache.maven.plugins 69 | maven-source-plugin 70 | 2.2.1 71 | 72 | 73 | attach-sources 74 | 75 | jar-no-fork 76 | 77 | 78 | 79 | 80 | 81 | org.apache.maven.plugins 82 | maven-jar-plugin 83 | 2.4 84 | false 85 | true 86 | 87 | 88 | org.apache.maven.plugins 89 | maven-gpg-plugin 90 | 91 | 92 | sign-artifacts 93 | verify 94 | 95 | sign 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | org.apache.maven.archetype 109 | archetype-packaging 110 | 2.3 111 | 112 | 113 | 114 | 115 | 116 | 117 | maven-archetype-plugin 118 | 2.3 119 | 120 | 121 | 122 | 123 | 124 | 125 | org.apache.maven.plugins 126 | maven-release-plugin 127 | 2.5.2 128 | 129 | false 130 | ossrh-release 131 | deploy 132 | v@{project.version} 133 | 134 | 135 | 136 | org.sonatype.plugins 137 | nexus-staging-maven-plugin 138 | 1.6.3 139 | true 140 | 141 | ossrh 142 | https://oss.sonatype.org/ 143 | true 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | ossrh 152 | https://oss.sonatype.org/content/repositories/snapshots 153 | 154 | 155 | ossrh 156 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 157 | 158 | 159 | 160 | 161 | -------------------------------------------------------------------------------- /vision-component-archetype/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 6 | com.inductiveautomation.ignitionsdk 7 | ignition-sdk-archetypes 8 | 1.2.1-SNAPSHOT 9 | 10 | 11 | Archetype - Ignition Vision Module Component Archetype 12 | Maven Archetype for an Ignition Vision Module Component 13 | http://github.com/inductiveautomation/ignition-sdk-archetypes 14 | 15 | vision-component-archetype 16 | maven-archetype 17 | 18 | 19 | 20 | 21 | org.apache.maven.archetype 22 | archetype-packaging 23 | 2.3 24 | 25 | 26 | 27 | 28 | 29 | 30 | maven-archetype-plugin 31 | 2.3 32 | 33 | 34 | 35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /vision-component-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | src/main/java 10 | 11 | 12 | src/main/resources 13 | 14 | 15 | 16 | 17 | 18 | 19 | src/main/java 20 | 21 | 22 | src/main/resources 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /vision-component-archetype/src/main/resources/META-INF/maven/archetype.xml: -------------------------------------------------------------------------------- 1 | 2 | vision-component-archetype 3 | 4 | -------------------------------------------------------------------------------- /vision-component-archetype/src/main/resources/archetype-resources/__rootArtifactId__-build/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${rootArtifactId} 9 | ${groupId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | ${groupId} 18 | ${rootArtifactId}-client 19 | ${version} 20 | 21 | 22 | ${groupId} 23 | ${rootArtifactId}-designer 24 | ${version} 25 | 26 | 27 | 28 | 29 | 30 | 31 | com.inductiveautomation.ignitionsdk 32 | ignition-maven-plugin 33 | 1.2.0 34 | 35 | 36 | 37 | package-modl 38 | package 39 | 40 | modl 41 | 42 | 43 | 44 | install-modl 45 | install 46 | 47 | post 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | ${rootArtifactId}-client 56 | C 57 | 58 | 59 | ${rootArtifactId}-designer 60 | CD 61 | 62 | 63 | 64 | ${groupId}.${rootArtifactId} 65 | ${project.parent.name} 66 | ${project.description} 67 | ${version} 68 | 8.1.33 69 | 70 | 71 | 72 | D 73 | ${package}.designer.DesignerHook 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | -------------------------------------------------------------------------------- /vision-component-archetype/src/main/resources/archetype-resources/__rootArtifactId__-client/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${rootArtifactId} 9 | ${groupId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | com.inductiveautomation.ignitionsdk 18 | vision-client-api 19 | ${ignition-sdk-version} 20 | pom 21 | provided 22 | 23 | 24 | 25 | 26 | 27 | 28 | org.apache.maven.plugins 29 | maven-compiler-plugin 30 | 3.2 31 | 32 | 17 33 | 17 34 | 35 | 36 | 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /vision-component-archetype/src/main/resources/archetype-resources/__rootArtifactId__-client/src/main/java/client/HelloWorldComponent.java: -------------------------------------------------------------------------------- 1 | package ${package}.client; 2 | 3 | import java.awt.*; 4 | 5 | import com.inductiveautomation.vision.api.client.components.model.AbstractVisionComponent; 6 | 7 | public class HelloWorldComponent extends AbstractVisionComponent { 8 | 9 | private String text = "Hello, world!"; 10 | 11 | public HelloWorldComponent() { 12 | setFont(new Font("Dialog", Font.PLAIN, 16)); 13 | setPreferredSize(new Dimension(250, 100)); 14 | } 15 | 16 | @Override 17 | protected void paintComponent(Graphics g) { 18 | g.setColor(Color.WHITE); 19 | g.fillRect(0, 0, getWidth(), getHeight()); 20 | 21 | // Set the font to our component's font property 22 | g.setFont(getFont()); 23 | FontMetrics fm = g.getFontMetrics(); 24 | 25 | // Calculate the x,y for the String's baseline in order to center it 26 | int stringWidth = fm.stringWidth(getText()); 27 | int stringX = (getWidth() - stringWidth) / 2; 28 | int stringY = (getHeight() / 2); 29 | 30 | g.setColor(Color.BLACK); 31 | g.drawString(getText(), stringX, stringY); 32 | } 33 | 34 | public String getText() { 35 | return text; 36 | } 37 | 38 | public void setText(String text) { 39 | String oldText = this.text; 40 | this.text = text; 41 | 42 | // Firing property changes like this is required for any 43 | // property that has the BOUND_MASK set on it. 44 | firePropertyChange("text", oldText, text); 45 | 46 | repaint(); 47 | } 48 | 49 | } 50 | -------------------------------------------------------------------------------- /vision-component-archetype/src/main/resources/archetype-resources/__rootArtifactId__-designer/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | ${rootArtifactId} 9 | ${groupId} 10 | ${version} 11 | 12 | 13 | ${artifactId} 14 | 15 | 16 | 17 | ${groupId} 18 | ${rootArtifactId}-client 19 | ${version} 20 | 21 | 22 | 23 | com.inductiveautomation.ignitionsdk 24 | designer-api 25 | ${ignition-sdk-version} 26 | pom 27 | provided 28 | 29 | 30 | 31 | com.inductiveautomation.ignitionsdk 32 | vision-designer-api 33 | ${ignition-sdk-version} 34 | pom 35 | provided 36 | 37 | 38 | 39 | 40 | 41 | 42 | org.apache.maven.plugins 43 | maven-compiler-plugin 44 | 3.2 45 | 46 | 17 47 | 17 48 | 49 | 50 | 51 | 52 | 53 | 54 | -------------------------------------------------------------------------------- /vision-component-archetype/src/main/resources/archetype-resources/__rootArtifactId__-designer/src/main/java/designer/DesignerHook.java: -------------------------------------------------------------------------------- 1 | package ${package}.designer; 2 | 3 | import ${package}.client.HelloWorldComponent; 4 | import com.inductiveautomation.ignition.common.licensing.LicenseState; 5 | import com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook; 6 | import com.inductiveautomation.ignition.designer.model.DesignerContext; 7 | import com.inductiveautomation.vision.api.designer.VisionDesignerInterface; 8 | import com.inductiveautomation.vision.api.designer.palette.JavaBeanPaletteItem; 9 | import com.inductiveautomation.vision.api.designer.palette.Palette; 10 | import com.inductiveautomation.vision.api.designer.palette.PaletteItemGroup; 11 | 12 | public class DesignerHook extends AbstractDesignerModuleHook { 13 | 14 | @Override 15 | public void startup(DesignerContext context, LicenseState activationState) throws Exception { 16 | // Add the BeanInfo package to the search path 17 | context.addBeanInfoSearchPath("com.iccworkshop.designer.beaninfos"); 18 | 19 | // Add my component to its own palette 20 | VisionDesignerInterface vdi = (VisionDesignerInterface) context 21 | .getModule(VisionDesignerInterface.VISION_MODULE_ID); 22 | 23 | if (vdi != null) { 24 | Palette palette = vdi.getPalette(); 25 | 26 | PaletteItemGroup group = palette.addGroup("Example"); 27 | group.addPaletteItem(new JavaBeanPaletteItem(HelloWorldComponent.class)); 28 | } 29 | } 30 | 31 | } 32 | -------------------------------------------------------------------------------- /vision-component-archetype/src/main/resources/archetype-resources/__rootArtifactId__-designer/src/main/java/designer/beaninfos/HelloWorldComponentBeanInfo.java: -------------------------------------------------------------------------------- 1 | package ${package}.designer.beaninfos; 2 | 3 | import java.beans.IntrospectionException; 4 | 5 | import ${package}.client.HelloWorldComponent; 6 | import com.inductiveautomation.factorypmi.designer.property.customizers.DynamicPropertyProviderCustomizer; 7 | import com.inductiveautomation.factorypmi.designer.property.customizers.StyleCustomizer; 8 | import com.inductiveautomation.vision.api.designer.beans.CommonBeanInfo; 9 | import com.inductiveautomation.vision.api.designer.beans.VisionBeanDescriptor; 10 | 11 | public class HelloWorldComponentBeanInfo extends CommonBeanInfo { 12 | 13 | public HelloWorldComponentBeanInfo() { 14 | super(HelloWorldComponent.class, 15 | DynamicPropertyProviderCustomizer.VALUE_DESCRIPTOR, 16 | StyleCustomizer.VALUE_DESCRIPTOR); 17 | } 18 | 19 | @Override 20 | protected void initProperties() throws IntrospectionException { 21 | super.initProperties(); 22 | 23 | addProp("text", "Text", "The text to display in the component", CAT_DATA, PREFERRED_MASK | BOUND_MASK); 24 | } 25 | 26 | @Override 27 | protected void initDesc() { 28 | VisionBeanDescriptor bean = getBeanDescriptor(); 29 | bean.setName("Hello World"); 30 | bean.setDisplayName("Hello World"); 31 | bean.setShortDescription("A component that displays the text 'Hello World'."); 32 | } 33 | 34 | } 35 | -------------------------------------------------------------------------------- /vision-component-archetype/src/main/resources/archetype-resources/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | ${groupId} 8 | ${artifactId} 9 | ${version} 10 | pom 11 | 12 | ${rootArtifactId} Ignition Module 13 | ${rootArtifactId} Ignition Module 14 | 15 | 16 | 8.1.33 17 | 18 | 19 | 20 | ${rootArtifactId}-build 21 | ${rootArtifactId}-client 22 | ${rootArtifactId}-designer 23 | 24 | 25 | 26 | 27 | releases 28 | https://nexus.inductiveautomation.com/repository/inductiveautomation-releases 29 | 30 | true 31 | always 32 | 33 | 34 | false 35 | 36 | 37 | 38 | 39 | 40 | 41 | releases 42 | https://nexus.inductiveautomation.com/repository/inductiveautomation-releases 43 | 44 | false 45 | 46 | 47 | true 48 | always 49 | 50 | 51 | 52 | 53 | snapshots 54 | https://nexus.inductiveautomation.com/repository/inductiveautomation-snapshots 55 | 56 | true 57 | always 58 | 59 | 60 | false 61 | 62 | 63 | 64 | 65 | thirdparty 66 | https://nexus.inductiveautomation.com/repository/inductiveautomation-thirdparty 67 | 68 | true 69 | always 70 | 71 | 72 | false 73 | 74 | 75 | 76 | 77 | 78 | --------------------------------------------------------------------------------