监控急停按钮相关接口

监控急停按钮相关的接口由如下类实现。您可以在 c++\include\sensor 目录下找到对应的头文件以获取完整 API。

头文件	类名	说明
sensor_emergency_stop_monitor.h	EStopMonitor	急停按钮监控器，提供主动获取急停按钮状态和设置事件回调两种方式。

构造函数

• 方法原型：

  EStopMonitor(const EStopMConfig& cfg = EStopMConfig())

• 参数说明：

  参数名称	类型	说明
  cfg	输入参数	配置参数，具体参见 EStopMConfig。

启动监控

若配置中 EStopMConfig::auto_start_ 为 true（默认值），系统将自动启用监控，无需手动调用 run()。另外，多次调用 run() 方法无影响。

当启动监控后，注册的事件回调函数才可能被触发。

• 方法原型：

  bool run()

• 返回值：

  true 表示启动成功，false 表示启动失败。

暂停监控

当暂停监控后，注册的事件回调函数不会被触发。另外，多次调用 pause() 方法无影响。

• 方法原型：

  bool pause()

• 返回值：

  true 表示暂停成功，false 表示暂停失败。

是否正在监控

• 方法原型：

  bool is_running()

• 返回值：

  true 表示正在监控，false 表示未监控。

获取当前急停按钮的状态

• 方法原型：

  ESState get_state()

• 返回值：

  急停按钮的状态，具体参见 ESState。

注册急停按钮按下回调函数

• 方法原型：

  int set_pressed_event_callback(std::function<void()> f)

• 参数说明：

  参数名称	类型	说明
  f	输入参数	急停按钮按下的回调函数。 当 EStopMConfig::allow_multicb_ 为 true 时，允许设置多个回调函数。

• 返回值：

  0 或 1 表示成功，1 表示原有的回调函数被替换（仅在只允许一个回调函数的情况下才会出现）；-1 表示失败。

注册急停按钮释放回调函数

• 方法原型：

  int set_released_event_callback(std::function<void()> f)

• 参数说明：

  参数名称	类型	说明
  f	输入参数	急停按钮释放的回调函数。 当 EStopMConfig::allow_multicb_ 为 true 时，允许设置多个回调函数。

• 返回值：

  0 或 1 表示成功，1 表示原有的回调函数被替换（仅在只允许一个回调函数的情况下才会出现）；-1 表示失败。