Skip to content

Commit

Permalink
add gpio mapper for atlas 200DK
Browse files Browse the repository at this point in the history
Signed-off-by: zhangyanhua <zhangyanhua@huawei.com>
  • Loading branch information
orsline committed Feb 15, 2023
1 parent c7d53e0 commit b35e209
Show file tree
Hide file tree
Showing 14 changed files with 968 additions and 0 deletions.
11 changes: 11 additions & 0 deletions mappers/gpio-atlas200/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
FROM ubuntu:20.04
WORKDIR /usr/local/bin
COPY ./res /usr/local/res
COPY ./bin /usr/local/bin
RUN echo "HwHiAiUser:x:1000:1000::/home/HwHiAiUser:" >> /etc/passwd ; \
echo "HwHiAiUser:x:1024:" >> /etc/group ; \
echo "HwHiAiUser:!:17795:0:99999:7:::" >> /etc/shadow ; \
chown -R 1000:1000 /usr/local/bin; \
chown -R 1000:1000 /usr/local/res;
USER 1000
ENTRYPOINT ["./gpio","--v","4"]
16 changes: 16 additions & 0 deletions mappers/gpio-atlas200/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.PHONY: build test clean docker
help:
#
# Usage:
# make build : compile main.go
# make clean : clean binaries
# make docker : pack binaries to image
@echo
build:
go build -o ./bin/gpio ./cmd/main.go
@echo "[INFO] go build successful"
@echo "[INFO] you can cd ./bin to execute it"
clean:
rm -rf ./bin/*
docker:
docker build -f ./Dockerfile docker build -f ./Dockerfile -t mapper-gpio-device:v0.0.1 .
12 changes: 12 additions & 0 deletions mappers/gpio-atlas200/cmd/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package main

import (
"github.com/kubeedge/mappers-go/mapper-sdk-go/pkg/service"
"github.com/kubeedge/mappers-go/mappers/gpio-atlas200/driver"
)

// main gpio device program entry
func main() {
gpio := &driver.GPIO{}
service.Bootstrap("GPIO", gpio)
}
54 changes: 54 additions & 0 deletions mappers/gpio-atlas200/crd_example/gpio-deployment.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: gpio-deploy-edge-line
spec:
replicas: 1
selector:
matchLabels:
app: gpio-line1
template:
metadata:
labels:
app: gpio-line1
spec:
hostNetwork: true
containers:
- name: gpio-container
image: gpio-mapper-arm64:v1.0
imagePullPolicy: IfNotPresent
ports:
- containerPort: 1215
hostPort: 1215
hostIP: 0.0.0.0
securityContext:
privileged: false
volumeMounts:
- name: config-volume
mountPath: /opt/kubeedge/
- name: gpio0-direction
mountPath: /sys/class/gpio/gpio504/direction
- name: gpio1-direction
mountPath: /sys/class/gpio/gpio444/direction
- name: gpio0-value
mountPath: /sys/class/gpio/gpio504/value
- name: gpio1-value
mountPath: /sys/class/gpio/gpio444/value
nodeName: edge-a200
volumes:
- name: config-volume
configMap:
name: device-profile-config-edge-a200
- name: gpio0-direction
hostPath:
path: /sys/class/gpio/gpio504/direction
- name: gpio1-direction
hostPath:
path: /sys/class/gpio/gpio444/direction
- name: gpio0-value
hostPath:
path: /sys/class/gpio/gpio504/value
- name: gpio1-value
hostPath:
path: /sys/class/gpio/gpio444/value
restartPolicy: Always
78 changes: 78 additions & 0 deletions mappers/gpio-atlas200/crd_example/gpio-device-instance.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
apiVersion: devices.kubeedge.io/v1alpha2
kind: Device
metadata:
name: led-instance-01
labels:
model: led-model
spec:
deviceModelRef:
name: led-model
protocol:
customizedProtocol:
protocolName: GPIO
nodeSelector:
nodeSelectorTerms:
- matchExpressions:
- key: ''
operator: In
values:
- edge-a200 #pls give your edge node name
propertyVisitors:
- propertyName: red-power-status
collectCycle: 10000000000 #Mapper 从设备收集数据的频率
reportCycle: 1000000000 #Mapper 报告数据的频率
customizedProtocol:
protocolName: GPIO
configData:
pin: 0 #pls give your red light's Pin
- propertyName: green-power-status
collectCycle: 10000000000 #Mapper 从设备收集数据的频率
reportCycle: 1000000000 #Mapper 报告数据的频率
customizedProtocol:
protocolName: GPIO
configData:
pin: 1 #pls give your green light's Pin
- propertyName: yellow-power-status
collectCycle: 10000000000 #Mapper 从设备收集数据的频率
reportCycle: 1000000000 #Mapper 报告数据的频率
customizedProtocol:
protocolName: GPIO
configData:
pin: 2 #pls give your yellow light's Pin

status:
twins:
- propertyName: red-power-status
reported:
metadata:
timestamp: '1550049403598'
type: string
value: "OFF"
desired:
metadata:
timestamp: '1550049403598'
type: string
value: "OFF"
- propertyName: green-power-status
reported:
metadata:
timestamp: '1550049403598'
type: string
value: "OFF"
desired:
metadata:
timestamp: '1550049403598'
type: string
value: "ON"
- propertyName: yellow-power-status
reported:
metadata:
timestamp: '1550049403598'
type: string
value: "OFF"
desired:
metadata:
timestamp: '1550049403598'
type: string
value: "OFF"

26 changes: 26 additions & 0 deletions mappers/gpio-atlas200/crd_example/gpio-device-model.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
apiVersion: devices.kubeedge.io/v1alpha2
kind: DeviceModel
metadata:
name: led-model
namespace: default
spec:
properties:
- name: red-power-status
description: red
type:
string:
accessMode: ReadWrite
defaultValue: "OFF"
- name: green-power-status
description: green
type:
string:
accessMode: ReadWrite
defaultValue: "OFF"
- name: yellow-power-status
description: yellow
type:
string:
accessMode: ReadWrite
defaultValue: "ON"

132 changes: 132 additions & 0 deletions mappers/gpio-atlas200/driver/driver.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
package driver

import (
"encoding/json"
"fmt"
"strings"
"sync"
)

type GPIOProtocolConfig struct {
ProtocolName string `json:"protocolName"`
ProtocolConfigData `json:"configData"`
}

type ProtocolConfigData struct {
}

type GPIOProtocolCommonConfig struct {
CommonCustomizedValues `json:"customizedValues"`
}

type CommonCustomizedValues struct {
}
type GPIOVisitorConfig struct {
ProtocolName string `json:"protocolName"`
VisitorConfigData `json:"configData"`
}

type VisitorConfigData struct {
Pin int `json:"pin"`
}

// GPIO Realize the structure of random number
type GPIO struct {
mutex sync.Mutex
protocolConfig GPIOProtocolConfig
protocolCommonConfig GPIOProtocolCommonConfig
visitorConfig GPIOVisitorConfig
}

// InitDevice Sth that need to do in the first
// If you need mount a persistent connection, you should provide parameters in configmap's protocolCommon.
// and handle these parameters in the following function
func (d *GPIO) InitDevice(protocolCommon []byte) (err error) {
if protocolCommon != nil {
if err = json.Unmarshal(protocolCommon, &d.protocolCommonConfig); err != nil {
fmt.Printf("Unmarshal ProtocolCommonConfig error: %v\n", err)
return err
}
}
fmt.Println("GPIO devices do not need to be initialized")
return nil
}

// SetConfig Parse the configmap's raw json message
func (d *GPIO) SetConfig(protocolCommon, visitor, protocol []byte) (pin int, err error) {
d.mutex.Lock()
defer d.mutex.Unlock()
if protocolCommon != nil {
if err = json.Unmarshal(protocolCommon, &d.protocolCommonConfig); err != nil {
fmt.Printf("Unmarshal ProtocolCommonConfig error: %v\n", err)
return 0, err
}
}
if visitor != nil {
if err = json.Unmarshal(visitor, &d.visitorConfig); err != nil {
fmt.Printf("Unmarshal visitorConfig error: %v\n", err)
return 0, err
}
}
if protocol != nil {
if err = json.Unmarshal(protocol, &d.protocolConfig); err != nil {
fmt.Printf("Unmarshal ProtocolConfig error: %v\n", err)
return 0, err
}
}
return d.visitorConfig.Pin, nil
}

// ReadDeviceData is an interface that reads data from a specific device, data is a type of string
func (d *GPIO) ReadDeviceData(protocolCommon, visitor, protocol []byte) (data interface{}, err error) {
// Parse raw json message to get a virtualDevice instance
pin, err := d.SetConfig(protocolCommon, visitor, protocol)
if err != nil {
return nil, err
}
pinClient := Pin(pin)
if pinClient.Read() == '0' {
return "OFF", nil
}
return "ON", nil
}

// WriteDeviceData is an interface that write data to a specific device, data's DataType is Consistent with configmap
func (d *GPIO) WriteDeviceData(data interface{}, protocolCommon, visitor, protocol []byte) (err error) {
// Parse raw json message to get a virtualDevice instance
pin, err := d.SetConfig(protocolCommon, visitor, protocol)
if err != nil {
return err
}
status := data.(string)
pinClient := Pin(pin)
if strings.ToUpper(status) == "OFF" {
pinClient.SetOutPut()
pinClient.SetLow()

} else if strings.ToUpper(status) == "ON" {
pinClient.SetOutPut()
pinClient.SetHight()
} else {
fmt.Println("the command should be \"ON\" or \"OFF\"")
}
return nil
}

// StopDevice is an interface to disconnect a specific device
// This function is called when mapper stops serving
func (d *GPIO) StopDevice() (err error) {
// in this func, u can get ur device-instance in the client map, and give a safety exit
fmt.Println("----------Stop gpio Device Successful----------")
return nil
}

// GetDeviceStatus is an interface to get the device status true is OK , false is DISCONNECTED
func (d *GPIO) GetDeviceStatus(protocolCommon, visitor, protocol []byte) (status bool) {
err := Open()
defer Close()
if err != nil {
return false
}
return true
}
Loading

0 comments on commit b35e209

Please sign in to comment.