node package manager

kuco

Getting Started

install kuco

$ npm install -g kuco

add / delete assetView

$ kuco add:assetView <name-of-new-assetView> <list-of-sub-view-names>
$ kuco del:assetView <name-of-new-assetView>

add / delete service

$ kuco add:service <name-of-new-service> <list-of-injected-dependencies>
$ kuco del:service <name-of-new-service>

add / delete library

$ kuco add:library <name-of-new-library> <url-to-library>
$ kuco del:library <name-of-new-library>

start local webserver for running application

$ kuco serve
  • GTC needs to be accepted (only once)
  • choose the domain you want to connect to (usually this domain includes your tenant as well as the environment - e.g. for a tenant named 'stark' where we want to connect to the staging environment: 'https://stark-staging.onkuka.com')
  • choose whether you want to edit the existing webapplication (internal) for example by creating new asset views / services OR you want to create a whole new webapplication (external)
  • if you chose the option 'internal' you can start developing right now. If your selection was 'external' you need to log in (at the moment only via 'KUKA Connect' is available) and type in a url you want to grant access to the API. When your application is running under 'localhost:1234', just type so. Now your application has access to the API.

open link in browser & start developing

http://localhost:1138

get help for commands

$ kuco -h

Example

$ npm install -g kuco
$ kuco add:assetView Ironman Camera Cassis Energy
$ kuco add:service Infrared HttpService WebsocketService '$http' '$q'
$ kuco add:library D3js https://d3js.org/d3.v4.min.js 
$ kuco serve
  (... follow instuctions)

Upgrading to kuco 0.6.x

Release 0.6.0 of kuco introduced two breaking changes to existing kuco modules:

  • Each view within the module's directory must reside in MODULE_DIR/kuco/assetViews/MODULE_NAME, instead of the previous MODULE_DIR/custom/assetViews/MODULE_NAME
  • The module descriptor file config.json must reside directly in MODULE_DIR, i.e. it now resides alongside the kuco directory, instead of inside it.

All affected modules will have to be manually migrated:

  • Rename the directory "custom" to "kuco", and replace all references to "custom" with "kuco" in the module descriptor file config.js and any AngularJS controllers that load template files.
  • Move config.json from "kuco" to the module's root directory.