fix(ble): add test and refactor ble device connect

adaptors/ble/README.md

@@ -1,6 +1,8 @@
 # BLE Adaptor
 
-This is BLE(Bluetooth Low Energy) adaptor is used for bluetooth devices connection.
+BLE stands for Bluetooth Low Energy (marketed as Bluetooth Smart). BLE is a form of wireless communication designed for short-range communications. 
+
+BLE adaptor implements the Bluetooth protocol and helps to define the the attributes of the connected BLE device.
 
 ## Registration Information
 
@@ -43,10 +45,14 @@ Grant permissions to Octopus as below:
 
 Parameter | Description | Scheme | Required
 --- | --- | --- | ---
-name | Device name  | string | either device name or macAddress is required
-macAddress |  Device access mac address  | string | either name or macAddress is required
-properties | Device properties  | []*[DeviceProperty](#deviceproperty) | false
+protocol | Device protocol config  | [DeviceProtocol](#deviceprotocol) | true
+properties | Device properties     | []*[DeviceProperty](#deviceproperty) | false
 
+### DeviceProtocol
+Parameter | Description | Scheme | Required
+--- | --- | --- | ---
+name | Device name  | string | NOT required when the device macAddress is provided
+macAddress |  Device access mac address  | string | NOT required when the device name is provided
 
 ### DeviceProperty
 
@@ -116,8 +122,9 @@ spec:
       labels:
         device: xiaomi-temp-rs2200
     spec:
-      name: "MJ_HT_V1"
-      # macAddress: ""
+      protocol:
+        name: "MJ_HT_V1"
+        macAddress: ""
       properties:
       - name: data
         description: XiaoMi temp sensor with temperature and humidity data

adaptors/ble/api/v1alpha1/bluetoothdevice_types.go

@@ -2,21 +2,46 @@ package v1alpha1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // BluetoothDeviceSpec defines the desired state of BluetoothDevice
 type BluetoothDeviceSpec struct {
+	// Parameter of the modbus device.
+	// +optional
+	Parameters *Parameters `json:"parameters,omitempty"`
+
+	// Protocol for accessing the BLE device.
+	// +kubebuilder:validation:Required
+	Protocol DeviceProtocol `json:"protocol"`
+
+	// Specifies the properties of the BLE device.
+	// +optional
 	Properties []DeviceProperty `json:"properties,omitempty"`
-	Name       string           `json:"name,omitempty"`
-	MacAddress string           `json:"macAddress,omitempty"`
+}
+
+type Parameters struct {
+	// Specifies default device sync interval
+	// +kubebuilder:default:15s
+	SyncInterval v1.Duration `json:"syncInterval,omitempty"`
+
+	// Specifies default device connection timeout
+	// +kubebuilder:default:10s
+	Timeout v1.Duration `json:"timeout,omitempty"`
 }
 
 // DeviceProperty defines an individual ble device property
 type DeviceProperty struct {
-	Name        string             `json:"name,omitempty"`
+	Name        string             `json:"name"`
 	Description string             `json:"description,omitempty"`
-	AccessMode  PropertyAccessMode `json:"accessMode,omitempty"`
-	Visitor     PropertyVisitor    `json:"visitor,omitempty"`
+	AccessMode  PropertyAccessMode `json:"accessMode"`
+	Visitor     PropertyVisitor    `json:"visitor"`
+}
+
+// DeviceProtocol defines how to connect the BLE device
+type DeviceProtocol struct {
+	Name       string `json:"name,omitempty"`
+	MacAddress string `json:"macAddress,omitempty"`
 }
 
 // The access mode for  a device property.
@@ -31,7 +56,7 @@ const (
 
 // PropertyVisitor defines the specifics of accessing a particular device property
 type PropertyVisitor struct {
-	CharacteristicUUID     string                 `json:"characteristicUUID,omitempty"`
+	CharacteristicUUID     string                 `json:"characteristicUUID"`
 	DefaultValue           string                 `json:"defaultValue,omitempty"`
 	DataWriteTo            map[string][]byte      `json:"dataWrite,omitempty"`
 	BluetoothDataConverter BluetoothDataConverter `json:"dataConverter,omitempty"`
@@ -66,18 +91,18 @@ type BluetoothDeviceStatus struct {
 }
 
 type StatusProperties struct {
-	Name      string      `json:"name,omitempty"`
-	Desired   string      `json:"desired,omitempty"`
-	Reported  string      `json:"reported,omitempty"`
-	UpdatedAt metav1.Time `json:"updatedAt,omitempty"`
+	Name       string             `json:"name,omitempty"`
+	Value      string             `json:"value,omitempty"`
+	AccessMode PropertyAccessMode `json:"accessMode,omitempty"`
+	UpdatedAt  metav1.Time        `json:"updatedAt,omitempty"`
 }
 
 // +kubebuilder:object:root=true
 // +k8s:openapi-gen=true
 // +kubebuilder:resource:shortName=ble
 // +kubebuilder:subresource:status
-// +kubebuilder:printcolumn:name="Name",type=string,JSONPath=`.spec.name`
-// +kubebuilder:printcolumn:name="MacAddress",type=integer,JSONPath=`.spec.macAddress`
+// +kubebuilder:printcolumn:name="Name",type=string,JSONPath=`.spec.protocol.name`
+// +kubebuilder:printcolumn:name="MacAddress",type=integer,JSONPath=`.spec.protocol.macAddress`
 // +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
 // BluetoothDevice is the Schema for the ble device API
 type BluetoothDevice struct {

adaptors/ble/cmd/ble/main.go

@@ -13,7 +13,7 @@ import (
 
 const (
 	name        = "ble"
-	description = ``
+	description = "The BLE adaptor defines the device configuration and the attributes of connected BLE device"
 )
 
 func newCommand() *cobra.Command {

adaptors/ble/deploy/e2e/all_in_one.yaml

@@ -2,10 +2,10 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    devices.edge.cattle.io/description: BLE stands for Bluetooth Low Energy (Bluetooth
-      LE, , and marketed as Bluetooth Smart). BLE is a form of wireless communication
-      designed for short-range communications. The BLE adaptor defines the device
-      configuration and the attributes of connected BLE device.
+    devices.edge.cattle.io/description: BLE stands for Bluetooth Low Energy (marketed
+      as Bluetooth Smart). BLE is a form of wireless communication designed for short-range
+      communications. The BLE adaptor defines the device configuration and the attributes
+      of connected BLE device.
     devices.edge.cattle.io/device-property: '{"name":"string","dataType":"string","value":"string","updatedAt":"date"}'
     devices.edge.cattle.io/enable: "true"
     devices.edge.cattle.io/icon: https://octopus-assets.oss-cn-beijing.aliyuncs.com/adaptor-icons/ble-logo.svg
@@ -26,10 +26,10 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - jsonPath: .spec.name
+    - jsonPath: .spec.protocol.name
       name: Name
       type: string
-    - jsonPath: .spec.macAddress
+    - jsonPath: .spec.protocol.macAddress
       name: MacAddress
       type: integer
     - jsonPath: .metadata.creationTimestamp
@@ -55,11 +55,18 @@ spec:
           spec:
             description: BluetoothDeviceSpec defines the desired state of BluetoothDevice
             properties:
-              macAddress:
-                type: string
-              name:
-                type: string
+              parameters:
+                description: Parameter of the modbus device.
+                properties:
+                  syncInterval:
+                    description: Specifies default device sync interval
+                    type: string
+                  timeout:
+                    description: Specifies default device connection timeout
+                    type: string
+                type: object
               properties:
+                description: Specifies the properties of the BLE device.
                 items:
                   description: DeviceProperty defines an individual ble device property
                   properties:
@@ -105,25 +112,42 @@ spec:
                           type: object
                         defaultValue:
                           type: string
+                      required:
+                      - characteristicUUID
                       type: object
+                  required:
+                  - accessMode
+                  - name
+                  - visitor
                   type: object
                 type: array
+              protocol:
+                description: Protocol for accessing the BLE device.
+                properties:
+                  macAddress:
+                    type: string
+                  name:
+                    type: string
+                type: object
+            required:
+            - protocol
             type: object
           status:
             description: BluetoothDeviceStatus defines the observed state of BluetoothDevice
             properties:
               properties:
                 items:
                   properties:
-                    desired:
+                    accessMode:
+                      description: The access mode for  a device property.
                       type: string
                     name:
                       type: string
-                    reported:
-                      type: string
                     updatedAt:
                       format: date-time
                       type: string
+                    value:
+                      type: string
                   type: object
                 type: array
             type: object

adaptors/ble/deploy/e2e/dl-all.yaml

@@ -17,8 +17,9 @@ spec:
       labels:
         device: xiaomi-temp-rs2200
     spec:
-      name: "MJ_HT_V1"
-      # macAddress: ""
+      protocol:
+        name: "MJ_HT_V1"
+        macAddress: ""
       properties:
       - name: data
         description: XiaoMi temp sensor with temperature and humidity data

adaptors/ble/deploy/e2e/dl.yaml

@@ -4,11 +4,8 @@ metadata:
   name: xiaomi-temp-rs2200
 spec:
   adaptor:
-    node: ubuntu
+    node: edge-worker
     name: adaptors.edge.cattle.io/ble
-    parameters:
-      syncInterval: 30
-      timeout: 60
   model:
     apiVersion: "devices.edge.cattle.io/v1alpha1"
     kind: "BluetoothDevice"
@@ -17,8 +14,12 @@ spec:
       labels:
         device: xiaomi-temp-rs2200
     spec:
-      name: "MJ_HT_V1"
-      # macAddress: ""
+      parameters:
+        syncInterval: 15s
+        timeout: 10s
+      protocol:
+        name: "MJ_HT_V1"
+        macAddress: ""
       properties:
       - name: data
         description: XiaoMi temp sensor with temperature and humidity data