Categorygithub.com/edgexfoundry/sample-service
modulepackage
5.1.6+incompatible
Repository: https://github.com/edgexfoundry/sample-service.git
Documentation: pkg.go.dev

# README

sample-service

Build Status Code Coverage Go Report Card GitHub Latest Dev Tag) GitHub Latest Stable Tag) GitHub License GitHub go.mod Go version GitHub Pull Requests GitHub Contributors GitHub Committers GitHub Commit Activity

Not for production use

Sample service is a basic hello-world application that is used by the EdgeX DevOps working group for build automation / validation of Jenkins Pipelines.

The base functionality is derived from the 'device-random' service. This is a working service that will generate a random int8 value when queried.

Get an edgeX docker-compose from developer-scripts

To start the sample-service:

cd /sample-service
make clean
make docker
docker-compose up sample-service

Confirm the service edgexfoundry/docker-sample-service-go is running:

docker-compose ps

To access the API endpoints, in a webbrowser, CURL or POSTMAN,

http://localhost:48082/api/v1/device/name/sample-service01

The command endpoint for 'GenerateRandomValue_Int8' will be displayed and can be directly accessed. Take note that edge-core-command should be replaced by 'localhost' if you are running locally and the '<unique_ID>' fields are unique to your instance of EdgeX.

http://localhost:48082/api/v1/device/<unique_ID>/command/<unique_ID>

Useful References:

edgex-examples

device-random

# Packages

No description provided by the author
This package provides a implementation of a ProtocolDriver interface.

# Variables

Global version for device-sdk-go.