From 2ac61db2778ed112780c64a4361bb0900db4d2c8 Mon Sep 17 00:00:00 2001 From: Cloud Tsai Date: Fri, 16 Nov 2018 16:05:31 +0800 Subject: [PATCH] Initial commit of source code Signed-off-by: Cloud Tsai --- .gitignore | 19 +++ Dockerfile | 35 ++++++ LICENSE-2.0.txt | 201 ++++++++++++++++++++++++++++++ Makefile | 29 +++++ cmd/main.go | 22 ++++ cmd/res/configuration.toml | 87 +++++++++++++ cmd/res/device.random.yaml | 87 +++++++++++++ cmd/res/docker/configuration.toml | 87 +++++++++++++ driver/randomdriver.go | 95 ++++++++++++++ glide.yaml | 12 ++ 10 files changed, 674 insertions(+) create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 LICENSE-2.0.txt create mode 100644 Makefile create mode 100644 cmd/main.go create mode 100644 cmd/res/configuration.toml create mode 100644 cmd/res/device.random.yaml create mode 100644 cmd/res/docker/configuration.toml create mode 100644 driver/randomdriver.go create mode 100644 glide.yaml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..762b426 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, build with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +*.log + +.idea/ +vendor/ +cmd/device-random +glide.lock diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..7358f62 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,35 @@ +# +# Copyright (C) 2018 IOTech Ltd +# +# SPDX-License-Identifier: Apache-2.0 + +FROM golang:1.9-alpine AS builder + +ENV GOPATH=/go +ENV PATH=$GOPATH/bin:$PATH + +RUN echo http://nl.alpinelinux.org/alpine/v3.6/main > /etc/apk/repositories; \ + echo http://nl.alpinelinux.org/alpine/v3.6/community >> /etc/apk/repositories + +RUN apk update && apk add make && apk add bash +RUN apk add curl && apk add git && apk add openssh + +RUN curl https://glide.sh/get | sh + +# set the working directory +WORKDIR $GOPATH/src/github.com/edgexfoundry/device-random + +COPY . . + +RUN make prepare +RUN make build + + +FROM scratch + +ENV APP_PORT=49988 +EXPOSE $APP_PORT + +COPY --from=builder /go/src/github.com/edgexfoundry/device-random/cmd / + +ENTRYPOINT ["/device-random","--registry","--profile=docker","--confdir=/res"] diff --git a/LICENSE-2.0.txt b/LICENSE-2.0.txt new file mode 100644 index 0000000..7337dfa --- /dev/null +++ b/LICENSE-2.0.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 IOTech, Ltd. + + 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. \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..3891998 --- /dev/null +++ b/Makefile @@ -0,0 +1,29 @@ +.PHONY: build test clean prepare update + +GO=CGO_ENABLED=0 go +GOFLAGS=-ldflags + +MICROSERVICES=cmd/device-random + +.PHONY: $(MICROSERVICES) + +build: $(MICROSERVICES) + go build ./... + +cmd/device-random: + $(GO) build -o $@ ./cmd + +test: + go test ./... -cover + +clean: + rm -f $(MICROSERVICES) + +prepare: + glide install + +update: + glide update + +run: + cd bin && ./edgex-launch.sh \ No newline at end of file diff --git a/cmd/main.go b/cmd/main.go new file mode 100644 index 0000000..c369a4a --- /dev/null +++ b/cmd/main.go @@ -0,0 +1,22 @@ +// -*- Mode: Go; indent-tabs-mode: t -*- +// +// Copyright (C) 2018 IOTech Ltd +// +// SPDX-License-Identifier: Apache-2.0 + +package main + +import ( + "github.com/edgexfoundry/device-random/driver" + "github.com/edgexfoundry/device-sdk-go/pkg/startup" +) + +const ( + version string = "1.0" + serviceName string = "device-random" +) + +func main() { + d := driver.RandomDriver{} + startup.Bootstrap(serviceName, version, &d) +} diff --git a/cmd/res/configuration.toml b/cmd/res/configuration.toml new file mode 100644 index 0000000..0921bc5 --- /dev/null +++ b/cmd/res/configuration.toml @@ -0,0 +1,87 @@ +[Service] +Host = "localhost" +Port = 49988 +ConnectRetries = 3 +Labels = [] +OpenMsg = "device random started" +ReadMaxLimit = 256 +Timeout = 5000 +EnableAsyncReadings = true +AsyncBufferSize = 16 + +[Registry] +Host = "localhost" +Port = 8500 +CheckInterval = "10s" +FailLimit = 3 +FailWaitTime = 10 + +[Clients] + [Clients.Data] + Name = "edgex-core-data" + Protocol = "http" + Host = "localhost" + Port = 48080 + Timeout = 5000 + + [Clients.Metadata] + Name = "edgex-core-metadata" + Protocol = "http" + Host = "localhost" + Port = 48081 + Timeout = 5000 + + [Clients.Logging] + Name = "edgex-support-logging" + Protocol = "http" + Host = "localhost" + Port = 48061 + +[Device] + DataTransform = true + InitCmd = "" + InitCmdArgs = "" + MaxCmdOps = 128 + MaxCmdValueLen = 256 + RemoveCmd = "" + RemoveCmdArgs = "" + ProfilesDir = "./res" + +[Logging] +EnableRemote = false +File = "./device-random.log" +Level = "INFO" + +# Pre-define Devices +[[DeviceList]] + Name = "Random-Integer-Generator01" + Profile = "Random-Integer-Generator" + Description = "Example of Device Random" + Labels = [ "device-random-example" ] + [DeviceList.Addressable] + Address = "device-random-01" + Protocol = "OTHER" + +# Pre-define Schedule Configuration +[[Schedules]] +Name = "5sec-schedule" +Frequency = "PT5S" + +[[ScheduleEvents]] +Name = "readValue_int8" +Schedule = "5sec-schedule" + [ScheduleEvents.Addressable] + HTTPMethod = "GET" + Path = "/api/v1/device/name/Random-Integer-Generator01/GenerateRandomValue_Int8" +[[ScheduleEvents]] +Name = "readValue_int16" +Schedule = "5sec-schedule" + [ScheduleEvents.Addressable] + HTTPMethod = "GET" + Path = "/api/v1/device/name/Random-Integer-Generator01/GenerateRandomValue_Int16" +[[ScheduleEvents]] +Name = "readValue_int32" +Schedule = "5sec-schedule" + [ScheduleEvents.Addressable] + HTTPMethod = "GET" + Path = "/api/v1/device/name/Random-Integer-Generator01/GenerateRandomValue_Int32" diff --git a/cmd/res/device.random.yaml b/cmd/res/device.random.yaml new file mode 100644 index 0000000..c84c540 --- /dev/null +++ b/cmd/res/device.random.yaml @@ -0,0 +1,87 @@ +name: "Random-Integer-Generator" +manufacturer: "IOTech" +model: "Device-Random-01" +labels: +- "device-random-example" +description: "Example of Device-Random" + +deviceResources: +- + name: "RandomValue_Int8" + description: "Generate random int8 value" + properties: + value: + { type: "Int8", readWrite: "R", minimum: "-128", maximum: "127", defaultValue: "0" } + units: + { type: "String", readWrite: "R", defaultValue: "random int8 value" } +- + name: "RandomValue_Int16" + description: "Generate random int16 value" + properties: + value: + { type: "Int16", readWrite: "R", minimum: "-32768", maximum: "32767", defaultValue: "0" } + units: + { type: "String", readWrite: "R", defaultValue: "random int16 value" } +- + name: "RandomValue_Int32" + description: "Generate random int32 value" + properties: + value: + { type: "Int32", readWrite: "R", minimum: "-2147483648", maximum: "2147483647", defaultValue: "0" } + units: + { type: "String", readWrite: "R", defaultValue: "random int32 value" } + +resources: +- + name: "GenerateRandomValue_Int8" + get: + - { operation: "get", object: "RandomValue_Int8", property: "value", parameter: "RandomValue_Int8" } +- + name: "GenerateRandomValue_Int16" + get: + - { operation: "get", object: "RandomValue_Int16", property: "value", parameter: "RandomValue_Int16" } +- + name: "GenerateRandomValue_Int32" + get: + - { operation: "get", object: "RandomValue_Int32", property: "value", parameter: "RandomValue_Int32" } + +commands: +- + name: "GenerateRandomValue_Int8" + get: + path: "/api/v1/device/{deviceId}/GenerateRandomValue_Int8" + responses: + - + code: "200" + description: "" + expectedValues: ["RandomValue_Int8"] + - + code: "503" + description: "service unavailable" + expectedValues: [] +- + name: "GenerateRandomValue_Int16" + get: + path: "/api/v1/device/{deviceId}/GenerateRandomValue_Int16" + responses: + - + code: "200" + description: "" + expectedValues: ["RandomValue_Int16"] + - + code: "503" + description: "service unavailable" + expectedValues: [] +- + name: "GenerateRandomValue_Int32" + get: + path: "/api/v1/device/{deviceId}/GenerateRandomValue_Int32" + responses: + - + code: "200" + description: "" + expectedValues: ["RandomValue_Int32"] + - + code: "503" + description: "service unavailable" + expectedValues: [] \ No newline at end of file diff --git a/cmd/res/docker/configuration.toml b/cmd/res/docker/configuration.toml new file mode 100644 index 0000000..4adeb2f --- /dev/null +++ b/cmd/res/docker/configuration.toml @@ -0,0 +1,87 @@ +[Service] +Host = "device-random" +Port = 49988 +ConnectRetries = 3 +Labels = [] +OpenMsg = "device random started" +ReadMaxLimit = 256 +Timeout = 5000 +EnableAsyncReadings = true +AsyncBufferSize = 16 + +[Registry] +Host = "edgex-core-consul" +Port = 8500 +CheckInterval = "10s" +FailLimit = 3 +FailWaitTime = 10 + +[Clients] + [Clients.Data] + Name = "edgex-core-data" + Protocol = "http" + Host = "edgex-core-data" + Port = 48080 + Timeout = 5000 + + [Clients.Metadata] + Name = "edgex-core-metadata" + Protocol = "http" + Host = "edgex-core-metadata" + Port = 48081 + Timeout = 5000 + + [Clients.Logging] + Name = "edgex-support-logging" + Protocol = "http" + Host = "edgex-support-logging" + Port = 48061 + +[Device] + DataTransform = true + InitCmd = "" + InitCmdArgs = "" + MaxCmdOps = 128 + MaxCmdValueLen = 256 + RemoveCmd = "" + RemoveCmdArgs = "" + ProfilesDir = "./res" + +[Logging] +EnableRemote = true +File = "/edgex/logs/device-random.log" +Level = "INFO" + +# Pre-define Devices +[[DeviceList]] + Name = "Random-Integer-Generator01" + Profile = "Random-Integer-Generator" + Description = "Example of Device Random" + Labels = [ "device-random-example" ] + [DeviceList.Addressable] + Address = "device-random-01" + Protocol = "OTHER" + +# Pre-define Schedule Configuration +[[Schedules]] +Name = "5sec-schedule" +Frequency = "PT5S" + +[[ScheduleEvents]] +Name = "readValue_int8" +Schedule = "5sec-schedule" + [ScheduleEvents.Addressable] + HTTPMethod = "GET" + Path = "/api/v1/device/name/Random-Integer-Generator01/GenerateRandomValue_Int8" +[[ScheduleEvents]] +Name = "readValue_int16" +Schedule = "5sec-schedule" + [ScheduleEvents.Addressable] + HTTPMethod = "GET" + Path = "/api/v1/device/name/Random-Integer-Generator01/GenerateRandomValue_Int16" +[[ScheduleEvents]] +Name = "readValue_int32" +Schedule = "5sec-schedule" + [ScheduleEvents.Addressable] + HTTPMethod = "GET" + Path = "/api/v1/device/name/Random-Integer-Generator01/GenerateRandomValue_Int32" diff --git a/driver/randomdriver.go b/driver/randomdriver.go new file mode 100644 index 0000000..2428275 --- /dev/null +++ b/driver/randomdriver.go @@ -0,0 +1,95 @@ +// -*- Mode: Go; indent-tabs-mode: t -*- +// +// Copyright (C) 2018 IOTech Ltd +// +// SPDX-License-Identifier: Apache-2.0 + +// This package provides a implementation of a ProtocolDriver interface. +// +package driver + +import ( + "fmt" + "math/rand" + "strconv" + "time" + + dsModels "github.com/edgexfoundry/device-sdk-go/pkg/models" + "github.com/edgexfoundry/edgex-go/pkg/clients/logging" + "github.com/edgexfoundry/edgex-go/pkg/models" +) + +type RandomDriver struct { + lc logger.LoggingClient + asyncCh chan<- *dsModels.AsyncValues +} + +func random(min int, max int) int { + return rand.Intn(max-min) + min +} + +func (d *RandomDriver) DisconnectDevice(address *models.Addressable) error { + d.lc.Info(fmt.Sprintf("RandomDriver.DisconnectDevice: device-random driver is disconnecting to %v", address)) + return nil +} + +func (d *RandomDriver) Initialize(lc logger.LoggingClient, asyncCh chan<- *dsModels.AsyncValues) error { + d.lc = lc + d.asyncCh = asyncCh + return nil +} + +func (d *RandomDriver) HandleReadCommands(addr *models.Addressable, reqs []dsModels.CommandRequest) (res []*dsModels.CommandValue, err error) { + res = make([]*dsModels.CommandValue, len(reqs)) + now := time.Now().UnixNano() / int64(time.Millisecond) + rand.Seed(time.Now().UnixNano()) + + for i, req := range reqs { + t := req.DeviceObject.Properties.Value.Type + defMin, defMax := 0, 0 + + switch t { + case "Int8": + defMin, defMax = -128, 127 + case "Int16": + defMin, defMax = -32768, 32767 + case "Int32": + defMin, defMax = -2147483648, 2147483647 + } + + min, e := strconv.Atoi(req.DeviceObject.Properties.Value.Minimum) + if e != nil || min < defMin || min > defMax { + err = fmt.Errorf("RandomDriver.HandleReadCommands: minimum value %d of %T must be int between %d ~ %d", min, min, defMin, defMax) + return + } + + max, e := strconv.Atoi(req.DeviceObject.Properties.Value.Maximum) + if e != nil || max < defMin || max > defMax || max < min { + err = fmt.Errorf("RandomDriver.HandleReadCommands: maximum value %d of %T must be int between %d ~ %d and greater than min", max, max, defMin, defMax) + return + } + + var cv *dsModels.CommandValue + switch t { + case "Int8": + cv, _ = dsModels.NewInt8Value(&req.RO, now, int8(random(min, max))) + case "Int16": + cv, _ = dsModels.NewInt16Value(&req.RO, now, int16(random(min, max))) + case "Int32": + cv, _ = dsModels.NewInt32Value(&req.RO, now, int32(random(min, max))) + } + res[i] = cv + } + + return +} + +func (d *RandomDriver) HandleWriteCommands(addr *models.Addressable, reqs []dsModels.CommandRequest, + params []*dsModels.CommandValue) error { + return fmt.Errorf("RandomDriver.HandleWriteCommands: device-random doesn't support write operation") +} + +func (d *RandomDriver) Stop(force bool) error { + d.lc.Info("RandomDriver.Stop: device-random driver is stopping...") + return nil +} diff --git a/glide.yaml b/glide.yaml new file mode 100644 index 0000000..f9b9fe3 --- /dev/null +++ b/glide.yaml @@ -0,0 +1,12 @@ +package: github.com/edgexfoundry/device-random +import: +- package: github.com/edgexfoundry/device-sdk-go + version: delhi + subpackages: + - /pkg/models + - /pkg/startup +- package: github.com/edgexfoundry/edgex-go + version: delhi + subpackages: + - /pkg/models + - /pkg/clients/logging