Overview

The SDK is designed in such a way that to create a new Asset Link, you need to implement the interfaces of the feature that the particular Asset Link is intended to provide Currently, one interface is supported:

Discovery Interface (allows device discoveries and consists of three functions):

  1. Discover: Performs a device scan and returns/publishes all the devices found.
  2. GetSupportedFilters: Returns a list of supported filters for the discovery.
  3. GetSupportedOptions: Returns a list of supported options for the discovery.

Once the interfaces are implemented, the specific Asset Link uses the assetLinkBuilder to construct a AssetLink with the implemented features. On AssetLink.Start() the Asset Link will start the grpc server allowing a device management to interact with it.

Pre-requisites

Tooling:

Gateway:

Have a gateway stack running to connect the Asset Link to. The gateway needs to implement server for the grpcRegistry and implement the necessary clients for the specific Asset Link capabilities. For discovery these clients need to be implemented:

You can download and use the Asset Gateway from the Siemens Industrial Asset Hub (IAH) for that

To ease local development a container image of a registry server is provided as part of the Asset Gateway. Additionally, a command line tool called al-ctl is provided to locally run and test the Asset Links.

To run these components use the following commands:

# to start the registry
$ docker-compose -f registry/docker-compose.yml up

# to start the al-ctl
$ go run ./cmd/al-ctl/al-ctl.go
# or
$ go run ./cmd/al-ctl/al-ctl.go  --help