From 61eadb08bb1115443b111e392d0c510be384e776 Mon Sep 17 00:00:00 2001 From: Iain Anderson Date: Tue, 29 Nov 2022 19:06:00 +0000 Subject: [PATCH 1/2] docs(snap): add snap/README Co-authored-by: Mengyi Wang Signed-off-by: Iain Anderson --- snap/README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 snap/README.md diff --git a/snap/README.md b/snap/README.md new file mode 100644 index 0000000..2749e40 --- /dev/null +++ b/snap/README.md @@ -0,0 +1,46 @@ +# EdgeX Grove Device Service Snap +[![snap store badge](https://raw.githubusercontent.com/snapcore/snap-store-badges/master/EN/%5BEN%5D-snap-store-black-uneditable.png)](https://snapcraft.io/edgex-device-grove) + +This folder contains snap packaging for the EdgeX Grove Device Service Snap + +The snap currently supports `arm64` platform. + +## Installation + +### Installing snapd +The snap can be installed on any system that supports snaps. +You can see how to install snaps on your system [here](https://snapcraft.io/docs/installing-snapd/6735). + +However for full security confinement, the snap should be installed on an +Ubuntu 18.04 LTS or later (Desktop or Server), or a system running Ubuntu Core 18 or later. + +### Installing EdgeX Device Grove as a snap +The snap is published in the snap store as [edgex-device-grove](https://snapcraft.io/edgex-device-grove). +You can see the current revisions available for your machine's architecture by running the command: +```bash +snap info edgex-device-grove +``` + +The snap can be installed using: +```bash +sudo snap install edgex-device-grove +``` + +## Snap configuration + + +Snapd doesn't support orchestration between services in different snaps. +It is therefore possible on a reboot for a device service to come up faster than all of the required services running in the main edgexfoundry snap. +If this happens, +the device service may repeatedly fail startup, +and if it exceeds the systemd default limits, +then it might be left in a failed state. +This situation might be more likely on constrained hardware (e.g. RPi). + +The default configuration file is in `/var/snap/edgex-device-grove/current/config/edgex-device-grove/res`. + +This device service is started by default. +Changes to the configuration files require a restart to take effect: +```bash +sudo snap restart edgex-device-grove +``` From 3ce6cba52f04b06e8a2fb10fc68179d09d9925b4 Mon Sep 17 00:00:00 2001 From: Iain Anderson Date: Tue, 29 Nov 2022 19:00:48 +0000 Subject: [PATCH 2/2] docs: device service is no longer supported Signed-off-by: Iain Anderson --- CHANGES | 2 +- README.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index 2fe78b1..a60d85c 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,4 @@ -Changes for release v2.2.0 +Changes for release v2.x (UNRELEASED) - Device service updated to use C SDK (v2.2.0) - Update to mraa library version 2.2.0 diff --git a/README.md b/README.md index 0c21208..9bbf115 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Device Grove Service [![Build Status](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/device-grove-c/job/main/badge/icon)](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/device-grove-c/job/main/) [![GitHub Latest Dev Tag)](https://img.shields.io/github/v/tag/edgexfoundry/device-grove-c?include_prereleases&sort=semver&label=latest-dev)](https://github.com/edgexfoundry/device-grove-c/tags) ![GitHub Latest Stable Tag)](https://img.shields.io/github/v/tag/edgexfoundry/device-grove-c?sort=semver&label=latest-stable) [![GitHub License](https://img.shields.io/github/license/edgexfoundry/device-grove-c)](https://choosealicense.com/licenses/apache-2.0/) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr-raw/edgexfoundry/device-grove-c)](https://github.com/edgexfoundry/device-grove-c/pulls) [![GitHub Contributors](https://img.shields.io/github/contributors/edgexfoundry/device-grove-c)](https://github.com/edgexfoundry/device-grove-c/contributors) [![GitHub Committers](https://img.shields.io/badge/team-committers-green)](https://github.com/orgs/edgexfoundry/teams/device-grove-c-committers/members) [![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/edgexfoundry/device-grove-c)](https://github.com/edgexfoundry/device-grove-c/commits) +## Status + +This device service has not been released in EdgeX since 1.3.x "Hanoi". Although the codebase has been updated for EdgeX v2, it is not supported by EdgeX Foundry and as such this repository is archived. ## About The EdgeX Device Grove Service is developed to control/communicate Grove sensors connected on Grove PI in an EdgeX deployment