Providing a Common MQTT Mapper #128
Conversation
Signed-off-by: Prometheus-collab <[email protected]>
|
Welcome @fuchendou! It looks like this is your first PR to kubeedge/mappers-go 🎉 |
kubeedge-bot
added
the
size/XXL
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: Prometheus-collab <[email protected]>
| DataType string `json:"dataType"` | ||
|
|
||
| ClientID string `json:"clientID"` // MQTT Client ID | ||
| DeviceInfo string `json:"deviceInfo"` // Device information, such as device identification or other important information. | ||
| OperationInfo OperationInfoType `json:"operationInfo"` // Operation information, such as adding, deleting, modifying and so on. | ||
| SerializedFormat SerializedFormatType `json:"fileType"` // Supported formats: json, xml and yaml. | ||
| ParsedMessage map[string]interface{} `json:"parsedMessage"` // The parsed message |
There was a problem hiding this comment.
Because mapper is a device management plug-in in kubeedge, it needs to complete the function of communicating with the actual edge IoT device and obtaining device data. According to your definition here, can mapper obtain the information and data of the actual mqtt device by subscribing to this ClientID?
There was a problem hiding this comment.
Thank you for your feedback! I have enriched the MQTT configuration fields in ConfigData.
| func (client *CustomizedClient) SafeSubscribe(topic string) (interface{}, error) { | ||
| client.deviceMutex.Lock() | ||
| defer client.deviceMutex.Unlock() | ||
|
|
||
| if client.MessageQueue == nil { | ||
| return nil, errors.New("message queue is not initialized") | ||
| } | ||
|
|
||
| // Call the Subscribe method of the message queue | ||
| msg, err := client.MessageQueue.Subscribe(topic) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to subscribe to topic: %v", err) | ||
| } | ||
| return msg, nil | ||
| } |
There was a problem hiding this comment.
In the design of mapper, the driver file is mainly used to complete the device driver function, that is, the function of connecting to the actual IoT device and obtaining device data. It is necessary to implement the functions of InitDevice GetDeviceData SetDeviceData and StopDevice according to the framework generated by mapper-framework. It seems that you have implemented the function of obtaining device data by subscribing to the device mqtt id, but you have not named the function to getdevicedata. In this way, the mapper data plane cannot obtain the device data normally and cannot push it to the cloud or user applications. For details, you can refer to the previous mapper implementation, which needs to include the functions of initdevice getdevicedata and more in the driver. https://github.com/kubeedge/mappers-go/blob/main/mappers/kubeedge-v1.15.0/usbcamera-dmi/driver/driver.go#L48
https://github.com/kubeedge/mappers-go/blob/main/mappers/kubeedge-v1.17.0/onvif-mapper/driver/driver.go#L26
There was a problem hiding this comment.
Thank you for your input! I have added the necessary functions to the code based on your feedback.
Signed-off-by: Prometheus-collab <[email protected]>
mappers/mqtt-mapper/driver/driver.go
Outdated
| func (c *CustomizedClient) GetDeviceData(visitor *VisitorConfig) (interface{}, error) { | ||
|
|
||
| return nil, nil | ||
| } |
There was a problem hiding this comment.
In other words, the mqtt mapper cannot get the value from the device, right?
There was a problem hiding this comment.
Thank you for your feedback! I have added the necessary functions to the code based on your feedback.
mappers/mqtt-mapper/driver/driver.go
Outdated
| "github.com/kubeedge/mapper-framework/pkg/common" | ||
| "gopkg.in/yaml.v3" |
There was a problem hiding this comment.
Please sort the import, those begin with github.com/kubeedge should be placed in the third part
There was a problem hiding this comment.
Thank you for your feedback! I have adjusted the order of the imports as you requested.
| @@ -0,0 +1,41 @@ | |||
| module github.com/kubeedge/kubeedge-v1.17.0 | |||
There was a problem hiding this comment.
The module name is not suitable. We usually use github.com/kubeedge/{mapperName}
There was a problem hiding this comment.
Thank you for your feedback! I have updated the module name in config.yaml to follow the format, which is github.com/kubeedge/{mapperName}.
| @@ -0,0 +1,15 @@ | |||
| apiVersion: v1 | |||
There was a problem hiding this comment.
The built-in mapper also needs to provide sample files of device model and device instance, such as https://github.com/kubeedge/mappers-go/blob/main/mappers/kubeedge-v1.17.0/onvif-mapper/resource/onvifdevice-instance.yaml
https://github.com/kubeedge/mappers-go/blob/main/mappers/kubeedge-v1.17.0/onvif-mapper/resource/onvifdevice-model.yaml
There was a problem hiding this comment.
Thank you for your suggestion! I have added the model and instance files to the appropriate locations as requested.
Signed-off-by: Prometheus-collab <[email protected]>
This PR introduces a universal MQTT Mapper designed to handle different serialization formats (JSON, YAML, and XML) during MQTT transmissions. The goal is to enhance flexibility and scalability for device communication.
Main Changes:
Improved ConfigData and VisitorConfigData structs to handle data before and after MQTT parsing.
Implemented methods for the ConfigData struct, including logic for serialization and parsing.
This PR fixes the issue: PR #链接