Package device

import "github.com/jcerato/device-sdk-go"

Overview
Index
Subdirectories

Overview

This package provides a basic EdgeX Foundry device service implementation meant to be embedded in an application, similar in approach to the builtin net/http package.

Index

Variables
func DriverConfigs() map[string]string
func SetOverwriteConfig(oc bool)
type Service
func NewService(serviceName string, serviceVersion string, confProfile string, confDir string, useRegistry string, proto dsModels.ProtocolDriver) (*Service, error)
func RunningService() *Service
func (s *Service) AddDevice(device contract.Device) (id string, err error)
func (s *Service) AddDeviceProfile(profile contract.DeviceProfile) (id string, err error)
func (s *Service) AddRoute(route string, handler func(http.ResponseWriter, *http.Request), methods ...string) error
func (s *Service) AsyncReadings() bool
func (s *Service) DeviceProfiles() []contract.DeviceProfile
func (*Service) DeviceResource(deviceName string, deviceResource string, method string) (contract.DeviceResource, bool)
func (s *Service) Devices() []contract.Device
func (s *Service) Discovery() dsModels.ProtocolDiscovery
func (s *Service) GetDeviceByName(name string) (contract.Device, error)
func (s *Service) Name() string
func (s *Service) RemoveDevice(id string) error
func (s *Service) RemoveDeviceByName(name string) error
func (s *Service) RemoveDeviceProfile(id string) error
func (*Service) RemoveDeviceProfileByName(name string) error
func (*Service) ResourceOperation(deviceName string, deviceResource string, method string) (contract.ResourceOperation, bool)
func (s *Service) Start(errChan chan error) (err error)
func (s *Service) Stop(force bool) error
func (s *Service) UpdateDevice(device contract.Device) error
func (*Service) UpdateDeviceProfile(profile contract.DeviceProfile) error
func (s *Service) Version() string
type Watchers

Package files

async.go manageddevices.go managedprofiles.go service.go version.go watchers.go

Variables

Global version for device-sdk-go

var Version string = "to be replaced by makefile"

func DriverConfigs

func DriverConfigs() map[string]string

DriverConfigs retrieves the driver specific configuration

func SetOverwriteConfig

func SetOverwriteConfig(oc bool)

SetOverwriteConfig sets whether or not configuration will be unconditionally loaded from file to the registry. NOTE this will be removed in the next release and made a parameter to NewService

type Service

A Service listens for requests and routes them to the right command

type Service struct {
    // contains filtered or unexported fields
}

func NewService

func NewService(serviceName string, serviceVersion string, confProfile string, confDir string, useRegistry string, proto dsModels.ProtocolDriver) (*Service, error)

NewService creates a new Device Service instance with the given version number, config profile, config directory, whether to use registry, and Driver, which cannot be nil. Note - this function is a singleton, if called more than once, it will always return an error.

func RunningService

func RunningService() *Service

RunningService returns the Service instance which is running

func (*Service) AddDevice

func (s *Service) AddDevice(device contract.Device) (id string, err error)

AddDevice adds a new Device to the Device Service and Core Metadata Returns new Device id or non-nil error.

func (*Service) AddDeviceProfile

func (s *Service) AddDeviceProfile(profile contract.DeviceProfile) (id string, err error)

AddDeviceProfile adds a new DeviceProfile to the Device Service and Core Metadata Returns new DeviceProfile id or non-nil error.

func (*Service) AddRoute

func (s *Service) AddRoute(route string, handler func(http.ResponseWriter, *http.Request), methods ...string) error

AddRoute allows leveraging the existing internal webserver to add routes specific to Device Service.

func (*Service) AsyncReadings

func (s *Service) AsyncReadings() bool

AsyncReadings returns a bool value to indicate whether the asynchronous reading is enabled.

func (*Service) DeviceProfiles

func (s *Service) DeviceProfiles() []contract.DeviceProfile

DeviceProfiles return all managed DeviceProfiles from cache

func (*Service) DeviceResource

func (*Service) DeviceResource(deviceName string, deviceResource string, method string) (contract.DeviceResource, bool)

DeviceResource retrieves the specific DeviceResource instance from cache according to the Device name and Device Resource name

func (*Service) Devices

func (s *Service) Devices() []contract.Device

Devices return all managed Devices from cache

func (*Service) Discovery

func (s *Service) Discovery() dsModels.ProtocolDiscovery

func (*Service) GetDeviceByName

func (s *Service) GetDeviceByName(name string) (contract.Device, error)

GetDeviceByName returns the Device by its name if it exists in the cache, or returns an error.

func (*Service) Name

func (s *Service) Name() string

Name returns the name of this Device Service

func (*Service) RemoveDevice

func (s *Service) RemoveDevice(id string) error

RemoveDevice removes the specified Device by id from the cache and ensures that the instance in Core Metadata is also removed.

func (*Service) RemoveDeviceByName

func (s *Service) RemoveDeviceByName(name string) error

RemoveDevice removes the specified Device by name from the cache and ensures that the instance in Core Metadata is also removed.

func (*Service) RemoveDeviceProfile

func (s *Service) RemoveDeviceProfile(id string) error

RemoveDeviceProfile removes the specified DeviceProfile by id from the cache and ensures that the instance in Core Metadata is also removed.

func (*Service) RemoveDeviceProfileByName

func (*Service) RemoveDeviceProfileByName(name string) error

RemoveDeviceProfileByName removes the specified DeviceProfile by name from the cache and ensures that the instance in Core Metadata is also removed.

func (*Service) ResourceOperation

func (*Service) ResourceOperation(deviceName string, deviceResource string, method string) (contract.ResourceOperation, bool)

ResourceOperation retrieves the first matched ResourceOpereation instance from cache according to the Device name, Device Resource name, and the method (get or set).

func (*Service) Start

func (s *Service) Start(errChan chan error) (err error)

Start the Device Service.

func (*Service) Stop

func (s *Service) Stop(force bool) error

Stop shuts down the Service

func (*Service) UpdateDevice

func (s *Service) UpdateDevice(device contract.Device) error

UpdateDevice updates the Device in the cache and ensures that the copy in Core Metadata is also updated.

func (*Service) UpdateDeviceProfile

func (*Service) UpdateDeviceProfile(profile contract.DeviceProfile) error

UpdateDeviceProfile updates the DeviceProfile in the cache and ensures that the copy in Core Metadata is also updated.

func (*Service) Version

func (s *Service) Version() string

Version returns the version number of this Device Service

type Watchers

type Watchers struct {
    // contains filtered or unexported fields
}

Subdirectories

Name	Synopsis

example
example/cmd
example/cmd/device-simple	This package provides a simple example of a device service.
example/driver	This package provides a simple example implementation of ProtocolDriver interface.
pkg
pkg/models	This package defines interfaces and structs used to build an EdgeX Foundry Device Service.
pkg/startup

github.com/jcerato/device-sdk-go

Go Device Service SDK

Overview

Usage

Community

License