grblHAL core  20241107
alarms.h File Reference

Go to the source code of this file.

Data Structures

struct  alarm_detail_t
 
struct  alarm_details
 

Typedefs

typedef struct alarm_details alarm_details_t
 
typedef alarm_details_t *(* on_get_alarms_ptr) (void)
 

Enumerations

enum  alarm_code_t {
  Alarm_None = 0 , Alarm_HardLimit = 1 , Alarm_SoftLimit = 2 , Alarm_AbortCycle = 3 ,
  Alarm_ProbeFailInitial = 4 , Alarm_ProbeFailContact = 5 , Alarm_HomingFailReset = 6 , Alarm_HomingFailDoor = 7 ,
  Alarm_FailPulloff = 8 , Alarm_HomingFailApproach = 9 , Alarm_EStop = 10 , Alarm_HomingRequired = 11 ,
  Alarm_LimitsEngaged = 12 , Alarm_ProbeProtect = 13 , Alarm_Spindle = 14 , Alarm_HomingFailAutoSquaringApproach = 15 ,
  Alarm_SelftestFailed = 16 , Alarm_MotorFault = 17 , Alarm_HomingFail = 18 , Alarm_AlarmMax = Alarm_HomingFail
}
 

Functions

alarm_details_talarms_get_details (void)
 
const char * alarms_get_description (alarm_code_t id)
 
void alarms_register (alarm_details_t *details)
 

Typedef Documentation

◆ alarm_details_t

◆ on_get_alarms_ptr

typedef alarm_details_t*(* on_get_alarms_ptr) (void)

Enumeration Type Documentation

◆ alarm_code_t

Enumerator
Alarm_None 

0

Alarm_HardLimit 

1

Alarm_SoftLimit 

2

Alarm_AbortCycle 

3

Alarm_ProbeFailInitial 

4

Alarm_ProbeFailContact 

5

Alarm_HomingFailReset 

6

Alarm_HomingFailDoor 

7

Alarm_FailPulloff 

8

Alarm_HomingFailApproach 

9

Alarm_EStop 

10

Alarm_HomingRequired 

11

Alarm_LimitsEngaged 

12

Alarm_ProbeProtect 

13

Alarm_Spindle 

14

Alarm_HomingFailAutoSquaringApproach 

15

Alarm_SelftestFailed 

16

Alarm_MotorFault 

17

Alarm_HomingFail 

18

Alarm_AlarmMax 

Function Documentation

◆ alarms_get_description()

const char* alarms_get_description ( alarm_code_t  id)

◆ alarms_get_details()

alarm_details_t* alarms_get_details ( void  )

◆ alarms_register()

void alarms_register ( alarm_details_t details)