diff --git a/modules/tools/cdmf-devicetype-archetype/README.md b/modules/tools/cdmf-devicetype-archetype/README.md index e838d225..c72d2e90 100644 --- a/modules/tools/cdmf-devicetype-archetype/README.md +++ b/modules/tools/cdmf-devicetype-archetype/README.md @@ -1,28 +1,49 @@ # cdmf-devicetype-archetype -To create new project +To install this maven archetype + go to this folder cdmf-devicetype-archetype + + mvn clean install +To create new project + go to this folder /wso2iots-1.0.0-SNAPSHOT/samples + mvn archetype:generate -DarchetypeCatalog=local Then select the cdmf.devicetype:cdmf-devicetype-archetype as new archetype. Then you need to provide groupId, artifactId, -version, packaging and name of your device type as shown bellow. +version, packaging, name of your device type and name for sensor as shown bellow. - Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): : 12 - Define value for property 'groupId': : org.coffeeking - Define value for property 'artifactId': : connectedcup + Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): : 3 + Define value for property 'groupId': : org.homeautomation + Define value for property 'artifactId': : safeLocker Define value for property 'version': 1.0-SNAPSHOT: : 1.0.0-SNAPSHOT - Define value for property 'package': org.coffeeking: : - Define value for property 'deviceType': : connectedCup + Define value for property 'package': org.homeautomation: : + Define value for property 'deviceType': : safeLocker + Define value for property 'nameOfTheSensor': : lock Confirm properties configuration: - groupId: org.coffeeking - artifactId: connectedcup + groupId: org.homeautomation + artifactId: safeLocker version: 1.0.0-SNAPSHOT - package: org.coffeeking - deviceType: connectedCup - Y: : Y - + package: org.homeautomation + deviceType: safeLocker + nameOfTheSensor: lock + + +To install sample app into IOTS + open '`device-deployer.xml` which is located in wso2iots-1.0.0-SNAPSHOT directory + Under featureArtifacts tag add feature artifact definition as below + + + org.homeautomation:org.homeautomation.safeLocker.feature:1.0.0-SNAPSHOT + + + Under features tag add feature group definition as below + + + org.homeautomation.safeLocker.feature.group + 1.0.0-SNAPSHOT + + + mvn clean install -f device-deployer.xml - - -