自定义驱动说明

    // 加入基础依赖 ，当前版本使用 1.3.7-SNAPSHOT 时间：2023.6.26
    compile('com.hvisions:driver-base:1.3.7-SNAPSHOT') {
        changing = true
    }

    // lombok 依赖
    compileOnly 'org.projectlombok:lombok:1.18.12'
    annotationProcessor 'org.projectlombok:lombok:1.18.12'
    testCompileOnly 'org.projectlombok:lombok:1.18.12'
    testAnnotationProcessor 'org.projectlombok:lombok:1.18.12'
    // Use JUnit test framework
    testImplementation 'junit:junit:4.13'

package com.hvisions.iot.drivers.base.annotation;

import com.hvisions.iot.drivers.base.connection.*;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Driver {
    String name();
    String desc();
    Model[] models();
    ProtocolType protocol();
    DriverType type();
    AccessType accessType();
    Class<?> driverConfig() default BaseConnectionConfig.class;
    boolean supportBrowse() default false;
    boolean enable() default true;
    String author() default "hvisions";
    String version() default "";
    String publishDateTime() default "";
}

package com.hvisions.iot.drivers.base.annotation;

import com.hvisions.iot.drivers.base.connection.ModelCategory;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Model {
    String name();
    String label() default "";
    String desc() default "";
    ModelCategory category();
}

package com.hvisions.iot.drivers.base.annotation;


import com.hvisions.iot.drivers.base.connection.ConfigDataType;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 属性注解
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldConfig {

    String label();

    String description() default "";

    String initialValue() default "";

    boolean required() default false;

    boolean display() default true;

    int order() default -1;

    ConfigDataType configDataType() default ConfigDataType.TEXT;

    boolean isArray() default false;

    String group() default "";

    /**
     * 同组条件
     */
    String condition() default "";
}

package com.hvisions.iot.drivers.base.connection;

import com.hvisions.iot.drivers.base.message.*;

import java.util.Collections;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;

public interface DriverReader {
    /**
     * 同步读取属性值
     *
     * @param request 请求的内容
     * @return ReadResponse对象
     */
    ReadResponse read(ReadRequest request);

    /**
     * 同步读取报警信息，默认Null
     * @return
     */
    default List<AlarmData> readAlarm() {
        return null;
    }

    /**
     * 异步读取属性值
     *
     * @param request 请求的内容
     * @return ReadResponse对象
     */
    CompletableFuture<ReadResponse> asyncRead(ReadRequest request);

    /**
     * 是否支持订阅
     *
     * @return true： 支持， false： 不支持
     */
    default boolean supportSubscribe() {
        return false;
    }
    /**
     * 订阅属性值
     *
     * @param request 订阅请求内容
     * @param notification 订阅通知函数
     * @return 订阅的ID号
     */
    default SubscriptionResponse subscribe(SubscriptionRequest request, Consumer<DataValue> notification) {
        return null;
    }


    /**
     * 列出属性结构树，比如opcua协议就可以支持该方法
     *
     * @return FieldNode结构树
     */
    default List<FieldNode> browse() {
        return Collections.emptyList();
    }

    /**
     * 设置数据回调函数，一般对于MQTT，文件方式需要数据回调的接口方式有效
     *
     * @param dataCallback 数据回调函数
     */
    default void setDataCallback(Consumer<FieldData> dataCallback) {
        // 默认不做任何设置
    }

    /**
     * 设置告警回调函数，一般对于MQTT，文件方式需要数据回调的接口方式有效
     *
     * @param alarmCallback 告警回调函数
     */
    default void setAlarmCallback(Consumer<AlarmData> alarmCallback) {
        // 默认不做任何设置
    }
}

package com.hvisions.iot.drivers.base.connection;

import com.hvisions.iot.drivers.base.message.WriteRequest;
import com.hvisions.iot.drivers.base.message.WriteResponse;

public interface DriverWriter {
    /**
     * 写入属性值
     *
     * @param request 写入请求
     * @return WriteResponse对象
     */
    WriteResponse write(WriteRequest request);
}

package com.hvisions.iot.drivers.base.connection;

import com.fasterxml.jackson.databind.JsonNode;
import com.hvisions.iot.drivers.base.message.DataType;
import com.hvisions.iot.drivers.base.message.ThingField;
import com.hvisions.iot.drivers.base.message.impl.DefaultThingField;
import com.hvisions.iot.drivers.base.message.*;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Consumer;

public interface DriverConnection
        extends DriverReader, DriverWriter {
    /**
     * 判断driver是否是集群模式，不要改变isCluster这个名称
     *
     * @param settings driver配置信息
     * @return true or false
     */
    public static boolean isCluster(JsonNode settings) {
        return false;
    }

    /**
     *
     * @param settings driver配置信息
     * @return driver配置信息列表
     */
    public static List<JsonNode> splitClusterSetting(JsonNode settings) {
        return Collections.singletonList(settings);
    }
    /**
     * 连接服务
     */
    void connect();

    /**
     * 是否已经连接成功
     *
     * @return true: 连接成功 false: 未连接成功
     */
    boolean isConnected();


    default void reconnect() {
        close();
        connect();
    }

    /**
     * 关闭连接
     */
    void close();

    /**
     * 生成ThingField对象
     *
     * @param name 属性名称
     * @param origin 属性地址
     * @param type 属性数据类型
     * @param unsigned 是否为无符号
     * @param arrayLength 数组长度，属性是数组是有效
     * @param equipmentId 设备id
     * @param thingFieldObject 点位对象定义信息
     * @return ThingField对象, 如果origin为非法的地址，返回为空
     */
    default ThingField buildField(String name, String origin, DataType type, Boolean unsigned,
                                  Integer arrayLength, String equipmentId, ThingFieldObject thingFieldObject) {
        return DefaultThingField.build(name, origin, type, unsigned, arrayLength, equipmentId, thingFieldObject);
    }

    /**
     * 属性定义是否是合法的地址
     *
     * @param origin ThingField地址定义
     * @return ture: 合法的地址， false： 不合法的地址
     */
    default boolean isFieldValid(String origin) {
        return true;
    }

    /**
     * 设置状态通知函数，当连接状态发生变化时，调用statusListener，true表示连接成功，false表示连接失败
     *
     * @param statusListener 状态通知函数
     */
    default void setConnectEventCallback(Consumer<Boolean> statusListener) {
    }

    /**
     *  获取 网关的概览信息
     * @return
     */
    default ConnOverview overviewInfo() {
        return null;
    }
}