command package - github.com/Circutor/edgex/internal/core/command

README ¶

EdgeX Foundry Core Command Service

Command Service is the conduit for other services to trigger action on devices/sensors via there managing device services. The service provides an API to get the list of commands that can be issued for all devices or a single device. Commands are divided into to groups for each device: Gets and Puts. Get commands are issued to a device/sensor get a current value for a particular attribute on the device (like the current temperature offered by a thermostat sensor, or like the on/off status of a light). Put commands are issued to a device/sensor to change the current state or status of a device or one of its attributes (like setting the speed in RPMs of a motor or setting the brightness of a dimmer light).

Install and Deploy Native

Prerequisites

Serveral EdgeX Foundry services depend on ZeroMQ for communications by default. The easiest way to get and install ZeroMQ is to use or follow the following setup script: https://gist.github.com/katopz/8b766a5cb0ca96c816658e9407e83d00.

Note: Setup of the ZeroMQ library is not supported on Windows plaforms.

Installation and Execution

To fetch the code and build the microservice execute the following:

cd $GOPATH/src
go get github.com/Circutor/edgex
cd $GOPATH/src/github.com/Circutor/edgex
# pull the 3rd party / vendor packages
make prepare
# build the microservice
make cmd/core-command/core-command
# get to the command microservice executable
cd cmd/core-command
# run the microservice (may require other dependent services to run correctly)
./core-command

Community

Chat: https://edgexfoundry.slack.com
Mainling lists: https://lists.edgexfoundry.org/mailman/listinfo

License

Apache-2.0

Documentation ¶

Overview ¶

******************************************************************************

Copyright 2018 Dell Inc. *
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing permissions and limitations under
the License. ******************************************************************************

******************************************************************************

Copyright 2018 Dell Inc. *
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing permissions and limitations under
the License. ******************************************************************************

******************************************************************************

Copyright 2017 Dell Inc. *
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing permissions and limitations under
the License. ******************************************************************************

******************************************************************************

Copyright 2017 Dell Inc.
Copyright (c) 2019 Intel Corporation *
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing permissions and limitations under
the License. ******************************************************************************

******************************************************************************

Copyright 2017 Dell Inc. *
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing permissions and limitations under
the License. ******************************************************************************

******************************************************************************

Copyright 2018 Dell Inc. *
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing permissions and limitations under
the License. ******************************************************************************

Index ¶

Constants
Variables
func Destruct()
func Init() bool
func LoadRestRoutes() http.Handler
func Retry(useProfile string, timeout int, wait *sync.WaitGroup, ch chan error)
type ConfigurationStruct
type WritableInfo

Constants ¶

View Source

const (
	ID               = "id"
	NAME             = "name"
	DEVICEIDURLPARAM = "{deviceId}"
	OPSTATE          = "opstate"
	URLADMINSTATE    = "adminstate"
	ADMINSTATE       = "adminState"
	YAML             = "yaml"
	COMMAND          = "command"
	COMMANDID        = "commandid"
	DEVICE           = "device"
	KEY              = "key"
	VALUE            = "value"
	PINGRESPONSE     = "pong"
	CONTENTTYPE      = "Content-Type"
	TEXTPLAIN        = "text/plain"
	UNLOCKED         = "UNLOCKED"
	ENABLED          = "ENABLED"
)

Variables ¶

View Source

var LoggingClient logger.LoggingClient

Functions ¶

func Destruct ¶

func Destruct()

func Init ¶

func Init() bool

func LoadRestRoutes ¶

func LoadRestRoutes() http.Handler

func Retry ¶

func Retry(useProfile string, timeout int, wait *sync.WaitGroup, ch chan error)

Types ¶

type ConfigurationStruct ¶

type ConfigurationStruct struct {
	Writable  WritableInfo
	Clients   map[string]config.ClientInfo
	Databases map[string]config.DatabaseInfo
	Logging   config.LoggingInfo
	Service   config.ServiceInfo
}

var Configuration *ConfigurationStruct

type WritableInfo ¶

type WritableInfo struct {
	LogLevel string
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL