HAL

简介

纳博特Ethercat主站控制器主站抖动时间小于20us，可用于工业自动化控制系统的开发，特别适用于机器人、伺服电机控制等实时性要求高的场景。

版本信息

| 二次开发版本 | 公司 | | 1.0.0 | INEXBOT |

版本迭代

| 版本 | 修改日期 | 修改人 | 描述 | | 1.0.0 | 20250310 | EA | 初始版本 |

概述

关于文档

本文旨在帮助用户使用纳博特libhal_sdk的C++库。

关于libhal_sdk库

该库为纳博特系统硬件抽象层，统一了用户接口，方便用户使用。

开发环境要求

函数库API说明

使用概述

1. 将 libhal_sdk.a 静态库文件复制到项目的 lib 目录

2. 将 include文件夹下的头文件复制到项目的 include 目录

3. 在编译时链接 libhal_sdk.a 库

demo下载

类列表

hal_sdk使用流程图

使用示例

demo.cpp

#include <hal/device_manager.h>
#include <hal/devices/digital_io.h>
#include <hal/devices/analog_io.h>
#include <hal/devices/can_device.h>
#include <hal/devices/pwm_device.h>
#include <hal/devices/encoder_device.h>
#include <hal/devices/ups_device.h>
#include <iostream>
#include <thread>
#include <chrono>


void print_device_info(const std::vector<std::string>& devices) {
    std::cout << "Devices:" << std::endl;
    for (const auto& name : devices) {
        std::cout << "- " << name << std::endl;
    }
    std::cout << std::endl;
}


int main() {
    auto& manager = hal::DeviceManager::instance();
    
    try {
        // 1. 展示设备管理器的查询功能
        std::cout << "\n=== 设备查询 ===" << std::endl;
        auto all_devices = manager.get_all_device_name_list();
        std::cout << "所有设备：" << std::endl;
        print_device_info(all_devices);


        // 获取特定类型设备列表
        auto dio_devices = manager.get_device_name_list(hal::DeviceType::DIGITAL_IO_);
        std::cout << "数字IO设备：" << std::endl;
        print_device_info(dio_devices);


        // 2. 通过DeviceManager获取设备并使用
        std::cout << "\n=== 设备使用示例 ===" << std::endl;
        
        // 使用数字IO
        if (auto dio_dev = manager.get_device(hal::DeviceType::DIGITAL_IO_, "DIO_1")) {
            auto digital_io = std::dynamic_pointer_cast<hal::DigitalIO>(dio_dev);
            digital_io->set_output(2, true);
            std::cout << "DIO_1 channel 3: " << digital_io->get_input(3) << std::endl;
        }


        // 使用模拟CAN设备
        if (auto can_dev = manager.get_device(hal::DeviceType::CAN_DEVICE_, "CAN_1")) {
            auto can_device = std::dynamic_pointer_cast<hal::CANDevice>(can_dev);
            can_device->open(0);
            can_device->set_parameters(0, 500000);
            unsigned char tx_data[8] = {0x11, 0x22, 0x33, 0x44};
            can_device->send(0, 0x123, tx_data, 4);
            unsigned int rx_id;
            unsigned char rx_data[16];
            unsigned int rx_len = can_device->receive(0, rx_id, rx_data);
            std::cout << "CAN_1 received length: " << rx_len << std::endl;
        }


        // 3. 设备存在性检查
        std::cout << "\n=== 设备存在性检查 ===" << std::endl;
        std::cout << "DIO_1 exists: " 
                  << manager.is_device_exist(hal::DeviceType::DIGITAL_IO_, "DIO_1") << std::endl;


    } catch (const std::exception& e) {
        std::cerr << "Error: " << e.what() << std::endl;
        return 1;
    }
    
    return 0;
}

函数库API详解

DeviceType 枚举

enum class DeviceType {
    NULL_,
    ANALOG_IO_,
    CAN_DEVICE_,
    DIGITAL_IO_,
    ENCODER_DEVICE_,
    PWM_DEVICE_,
    SERIAL_DEVICE_,
    UPS_DEVICE_,
    CUSTOM_
};

Device类

该类是所有设备对象的基类。

Device类定义

class Device {
public:
    Device(DeviceType device_type, const std::string& device_name);
    virtual ~Device() = default;
    
    bool valid() const { return valid_; }
    DeviceType get_device_type() const { return device_type_; }
    std::string get_device_name() const { return device_name_; }

protected:
    bool valid_{false};
    DeviceType device_type_;
    std::string device_name_;
};
}

Device类成员函数

Device类成员变量

成员函数功能详解

Device

~Device

valid

get_device_type

get_device_name

DeviceManager类

该类是device设备的管理器类。

类定义

class DeviceManager {
public:
    static DeviceManager &instance();


    int add_device(std::shared_ptr<Device> device);
    int remove_device(DeviceType device_type, const std::string& device_name);
    bool is_device_exist(DeviceType device_type, const std::string& device_name) const;
    
    std::vector<std::string> get_all_device_name_list() const;
    std::vector<std::string> get_device_name_list(DeviceType device_type) const;
    std::vector<std::shared_ptr<Device>> get_device_list(DeviceType device_type) const;
    std::shared_ptr<Device> get_device(DeviceType device_type, const std::string& device_name) const;


private:
    DeviceManager() = default;
    static void register_devices(DeviceManager &manager);
    std::unordered_map<std::string, std::shared_ptr<Device>> devices_;
};

类成员函数

类成员变量

成员函数功能详解

instance

add_device

remove_device

is_device_exist

get_all_device_name_list

get_device_name_list

get_device_list

get_device

AnalogIO类

该类是模拟io设备的抽象。

类定义

class AnalogIO : public Device {
public:
    AnalogIO(const std::string& name);
    virtual ~AnalogIO() = default;


    virtual void set_output(int channel, double value) = 0;
    virtual void set_outputs(const std::vector<int>& channels, const std::vector<double>& values) = 0;
    virtual double get_input(int channel) = 0;
    virtual std::vector<double> get_inputs(const std::vector<int>& channels) = 0;
    virtual int get_channel_count() const = 0;
    
    // 获取通道的量程范围
    virtual std::pair<double, double> get_range(int channel) const = 0;
};

类成员函数

类成员变量

| 变量名称 | 变量含义 | 类访问权限 |

AnalogIO类使用流程图

成员函数功能详解

AnalogIO

~AnalogIO

set_output

set_outputs

get_input

get_inputs

get_channel_count

get_range

CANDevice类

该类是can设备的抽象。

类定义

class CANDevice : public Device {
public:
    CANDevice(const std::string& name);
    virtual ~CANDevice() = default;
    virtual void open(int channel) = 0;
    virtual void close(int channel) = 0;
    virtual void set_parameters(int channel, int baudrate) = 0;
    virtual void set_recv_filter_id(int channel, bool enable_recv_filter, unsigned int recv_filter_id) = 0;
    virtual void set_frame_format(int channel, Frame_Format format) = 0;
    virtual bool detect_supported_function(int channel, Support_Function function) const = 0;
    virtual void send(int channel, unsigned int txid, const unsigned char buff[8], unsigned int len, bool use_remote_frame = false) = 0;
    virtual unsigned int receive(int channel, unsigned int & rxid, unsigned char buff[16]) = 0;
    virtual int get_channel_count() const = 0;
};

类成员函数

类成员变量

| 变量名称 | 变量含义 | 类访问权限 |

CANDEvice类使用流程图

成员函数功能详解

CANDevice

~CANDevice

open

close

set_parameters

set_recv_filter_id

set_frame_format

detect_supported_function

send

receive

get_channel_count

DigitalIO类

该类是数字IO的抽象。

类定义

class DigitalIO : public Device {
public:
    DigitalIO(const std::string& name);
    virtual ~DigitalIO() = default;


    virtual void set_output(int channel, bool state) = 0;
    virtual void set_outputs(const std::vector<int>& channels, const std::vector<bool>& states) = 0;
    virtual bool get_input(int channel) = 0;
    virtual std::vector<bool> get_inputs(const std::vector<int>& channels) = 0;
    virtual int get_channel_count() const = 0;
};

类成员函数

类成员变量

| 变量名称 | 变量含义 | 类访问权限 |

DigitalIO类使用流程图

成员函数功能详解

DigitalIO

~DigitalIO

set_output

set_outputs

get_input

get_inputs

get_channel_count

EncoderDevice类

该类是编码器设备的抽象。

类定义

class EncoderDevice : public Device {
public:
    EncoderDevice(const std::string& name);
    virtual ~EncoderDevice() = default;


    virtual int64_t get_encoder_value() const = 0;
    virtual std::pair<int64_t, int64_t> get_encoder_range() const = 0;
    virtual int get_encoder_direction() const = 0;  // 1:正转 -1:反转
};

类成员函数

类成员变量

| 变量名称 | 变量含义 | 类访问权限 |

EncoderDevice类使用流程图

成员函数功能详解

EncoderDevice

~EncoderDevice

get_encoder_value

get_encoder_range

get_encoder_direction

PwmDevice类

该类是pwm设备的抽象。

类定义

class PwmDevice : public Device {
public:
    PwmDevice(const std::string& name);
    virtual ~PwmDevice() = default;


    virtual void start_pwm() = 0;
    virtual void stop_pwm() = 0;
    virtual void set_freq(double freq) = 0;
    virtual void set_duty(double duty) = 0;
    virtual double get_freq() const = 0;
    virtual double get_duty() const = 0;
};

类成员函数

类成员变量

| 变量名称 | 变量含义 | 类访问权限 |

PwmDevice类使用流程图

成员函数功能详解

PwmDevice

~PwmDevice

start_pwm

stop_pwm

set_freq

set_duty

get_freq

get_duty

SerialDevice类

该类是ups设备的抽象。

类定义

class SerialDevice : public Device { // Remove ": public Device" if not needed
public:
    SerialDevice(const std::string& name);
    virtual ~SerialDevice() = default;
    virtual void open(int channel) = 0;
    virtual void close(int channel) = 0;
    virtual void set_parameters(int channel, int baudrate, char parity, int stop_bits) = 0;
    virtual int send(int channel, const std::vector<char>& data, size_t bytes_to_send) = 0;
    virtual int receive(int channel, std::vector<char>& buffer, size_t& bytes_received) = 0;
    virtual int get_channel_count() const = 0;
};

SerialDevice类使用流程图

成员函数功能详解

SerialDevice

~SerialDevice

open

close

set_parameters

send

receive

get_channel_count

UpsDevice类

该类是ups设备的抽象。

类定义

class UpsDevice : public Device {
public:
    UpsDevice(const std::string& name);
    virtual ~UpsDevice() = default;


    virtual bool get_ups_status() const = 0;  // true:触发 false:未触发
};

类成员函数

类成员变量

| 变量名称 | 变量含义 | 类访问权限 |

UpsDevice类使用流程图

成员函数功能详解

UpsDevice

~UpsDevice

get_ups_status

01.自定义指令

01.示教器实现

02.控制器实现

01.渐入式教程

03.接口示例

01.基础应用

02.进阶应用

01.渐入式教程

02.接口示例

01.渐入式教程

02.接口示例

01.基础应用

02.进阶应用

02.6000 端口通讯(2207)

01.运动控制

02.状态控制

03.工艺

06.激光切割工艺

04.作业文件

05.外部控制与通讯方式

06.其他

01.系统

02.机器人

01.参数设置

03.程序

02.程序-指令增删改查

04.外设_通讯

05.工艺

HAL ​

简介 ​

版本信息 ​

版本迭代 ​

概述 ​

关于文档 ​

关于libhal_sdk库 ​

开发环境要求 ​

函数库API说明 ​

使用概述 ​

类列表 ​

hal_sdk使用流程图 ​

使用示例 ​

demo.cpp ​

函数库API详解 ​

DeviceType 枚举 ​

Device类 ​

Device类定义 ​

Device类成员函数 ​

Device类成员变量 ​

成员函数功能详解 ​

Device ​

~Device ​

valid ​

get_device_type ​

get_device_name ​

DeviceManager类 ​

类定义 ​

类成员函数 ​

类成员变量 ​

成员函数功能详解 ​

instance ​

add_device ​

remove_device ​

is_device_exist ​

get_all_device_name_list ​

get_device_name_list ​

get_device_list ​

get_device ​

AnalogIO类 ​

类定义 ​

类成员函数 ​

类成员变量 ​

AnalogIO类使用流程图 ​

成员函数功能详解 ​

AnalogIO ​

~AnalogIO ​

set_output ​

set_outputs ​

get_input ​

get_inputs ​

get_channel_count ​

HAL

简介

版本信息

版本迭代

概述

关于文档

关于libhal_sdk库

开发环境要求

函数库API说明

使用概述

类列表

hal_sdk使用流程图

使用示例

demo.cpp

函数库API详解

DeviceType 枚举

Device类

Device类定义

Device类成员函数

Device类成员变量

成员函数功能详解

Device

~Device

valid

get_device_type

get_device_name

DeviceManager类

类定义

类成员函数

类成员变量

成员函数功能详解

instance

add_device

remove_device

is_device_exist

get_all_device_name_list

get_device_name_list

get_device_list

get_device

AnalogIO类

类定义

类成员函数

类成员变量

AnalogIO类使用流程图

成员函数功能详解

AnalogIO

~AnalogIO

set_output

set_outputs

get_input

get_inputs

get_channel_count

get_range

CANDevice类

类定义

类成员函数

类成员变量

CANDEvice类使用流程图

成员函数功能详解

CANDevice

~CANDevice

open

close

set_parameters

set_recv_filter_id

set_frame_format

detect_supported_function

send

receive

get_channel_count

DigitalIO类

类定义

类成员函数

类成员变量

DigitalIO类使用流程图

成员函数功能详解

DigitalIO

~DigitalIO

set_output

set_outputs