Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rightech/ric-edge
Rightech IoT Edge computing services
https://github.com/rightech/ric-edge
ble edge iot modbus opc-ua rightech snmp
Last synced: about 1 month ago
JSON representation
Rightech IoT Edge computing services
- Host: GitHub
- URL: https://github.com/rightech/ric-edge
- Owner: Rightech
- License: apache-2.0
- Created: 2019-09-20T06:19:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-22T10:12:22.000Z (10 months ago)
- Last Synced: 2024-06-20T11:15:24.942Z (6 months ago)
- Topics: ble, edge, iot, modbus, opc-ua, rightech, snmp
- Language: Go
- Homepage:
- Size: 5.84 MB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ric-edge
[](https://github.com/Rightech/ric-edge/actions?query=workflow%3A%22Build+and+release%22)
[](https://github.com/Rightech/ric-edge/releases/tag/v0.8.6)
## config
You can use `config.toml` file to configure core and connectors or specify path via `-config` option.
You can generate minimal required config with
```bash
$ ./core-- -min-config
```
Minimal configuration
```toml
[core]
id = "" # id of edge
[core.cloud]
# cloud jwt access token
# minimal scope should be
#
# GET models/:id
# GET objects/:id
token = ""
[core.mqtt]
cert_file = "" # mqtt certificate file path
key_path = "" # mqtt key file path
```
Also you can generate configuration with default values
```bash
$ ./core-- -default-config
```
Default configuration
```toml
log_level = "info"
log_format = "text" # output log format (you can use text or json)
ws_port = 9000
check_updates = true
auto_download_updates = false # if true service will download update and exit
[core]
id = "" # id of edge
rpc_timeout = "1m" # how long core should wait response from connector before return timeout error
[core.db]
path = "storage.db"
clean_state = false # should internal state be cleaned on start or not
[core.cloud]
url = "https://dev.rightech.io/api/v1"
# cloud jwt access token
# minimal scope should be
#
# GET models/:id
# GET objects/:id
token = ""
[core.mqtt]
# if cert_file and key_path provided core will be use tls connection
# in this case make sure your url start with tls://
url = "tls://dev.rightech.io:8883"
cert_file = "" # mqtt certificate file path
key_path = "" # mqtt key file path
[modbus]
mode = "tcp" # rtu and ascii also supported
addr = "localhost:8000" # if mode = rtu or ascii there is should be path
[opcua]
endpoint = "opc.tcp://localhost:4840"
encryption = "Basic256Sha256" # required for encrypted servers only, "Basic256Sha", "Basic256", "Basic128Rsa15" supported
mode = "SignAndEncrypt" # required for encrypted servers only, "None", "Sign", "SignAndEncrypt" supported
server_cert = "cert.pem" # required for encrypted servers only, path to .pem certificate
server_key = "key.pem" # required for encrypted servers only, path to .pem key
[snmp]
host_port="localhost:161"
community="public" # community string, required for v2c only
version="2c" # version of SNMP ("2c" or "3")
mode = "authPriv" # mode of encryption ("authPriv", "authNoPriv", "NoauthNoPriv"), required for v3 only
auth_protocol = "MD5" # "MD5" and "SHA" supported, required for v3 only (if necessary)
auth_key = "" # required for v3 only (if necessary)
priv_protocol = "DES" # "DES" and "AES" supported, required for v3 only (if necessary)
priv_key = "" # required for v3 only (if necessary)
security_name = "" # required for v3 only
```
## build
To build all services run
```bash
$ make build_all
```
also you can build specific service
```bash
$ make build_core
```
build results will be placed at `build` folder
## run
To run core service use
```bash
$ make run_core
```
To run connectors (modbus connector example)
```bash
$ make run_modbus
```
See [init](/init) folder for systemd services.
## dev
### dev env
You can find some development helpers at tools dir.
To run helper docker containers execute
```bash
$ make dev_env
```
To stop
```bash
$ make stop_env
```
And to remove
```bash
$ make rm_env
```
### git hooks
It is useful to place validate-license script to pre-commit hook. To do this run
```bash
$ ln -f scripts/validate-license.sh .git/hooks/pre-commit
```
Also you can run it manual by
```bash
$ make validate
```
### bumpversion
To prepare releases we use [bumpversion](https://pypi.org/project/bumpversion).