grblHAL core  20241107
ngc_params.h File Reference
#include "gcode.h"

Go to the source code of this file.

Data Structures

struct  ngc_param_t
 

Macros

#define NGC_MAX_PARAM_LENGTH   20
 
#define NGC_MAX_PARAM_ID   65535
 

Typedefs

typedef uint16_t ngc_param_id_t
 

Enumerations

enum  ncg_name_param_id_t {
  NGCParam_vmajor , NGCParam_vminor , NGCParam_line , NGCParam_motion_mode ,
  NGCParam_plane , NGCParam_ccomp , NGCParam_metric , NGCParam_imperial ,
  NGCParam_absolute , NGCParam_incremental , NGCParam_inverse_time , NGCParam_units_per_minute ,
  NGCParam_units_per_rev , NGCParam_coord_system , NGCParam_tool_offset , NGCParam_retract_r_plane ,
  NGCParam_retract_old_z , NGCParam_spindle_rpm_mode , NGCParam_spindle_css_mode , NGCParam_ijk_absolute_mode ,
  NGCParam_lathe_diameter_mode , NGCParam_lathe_radius_mode , NGCParam_spindle_on , NGCParam_spindle_cw ,
  NGCParam_mist , NGCParam_flood , NGCParam_speed_override , NGCParam_feed_override ,
  NGCParam_adaptive_feed , NGCParam_feed_hold , NGCParam_feed , NGCParam_rpm ,
  NGCParam_x , NGCParam_y , NGCParam_z , NGCParam_a ,
  NGCParam_b , NGCParam_c , NGCParam_u , NGCParam_v ,
  NGCParam_w , NGCParam_abs_x , NGCParam_abs_y , NGCParam_abs_z ,
  NGCParam_abs_a , NGCParam_abs_b , NGCParam_abs_c , NGCParam_abs_u ,
  NGCParam_abs_v , NGCParam_abs_w , NGCParam_current_tool , NGCParam_current_pocket ,
  NGCParam_selected_tool , NGCParam_selected_pocket , NGCParam_call_level , NGCParam_Last
}
 

Functions

uint8_t ngc_float_decimals (void)
 
bool ngc_param_get (ngc_param_id_t id, float *value)
 
bool ngc_param_set (ngc_param_id_t id, float value)
 
bool ngc_param_is_rw (ngc_param_id_t id)
 
bool ngc_param_exists (ngc_param_id_t id)
 
bool ngc_named_param_get (char *name, float *value)
 
float ngc_named_param_get_by_id (ncg_name_param_id_t id)
 
bool ngc_named_param_set (char *name, float value)
 
bool ngc_named_param_exists (char *name)
 
bool ngc_call_push (void *context)
 
bool ngc_call_pop (void)
 
uint_fast8_t ngc_call_level (void)
 
bool ngc_modal_state_save (gc_modal_t *state, bool auto_restore)
 
bool ngc_modal_state_restore (void)
 
void ngc_modal_state_invalidate (void)
 

Macro Definition Documentation

◆ NGC_MAX_PARAM_ID

#define NGC_MAX_PARAM_ID   65535

◆ NGC_MAX_PARAM_LENGTH

#define NGC_MAX_PARAM_LENGTH   20

Typedef Documentation

◆ ngc_param_id_t

typedef uint16_t ngc_param_id_t

Enumeration Type Documentation

◆ ncg_name_param_id_t

Enumerator
NGCParam_vmajor 
NGCParam_vminor 
NGCParam_line 
NGCParam_motion_mode 
NGCParam_plane 
NGCParam_ccomp 
NGCParam_metric 
NGCParam_imperial 
NGCParam_absolute 
NGCParam_incremental 
NGCParam_inverse_time 
NGCParam_units_per_minute 
NGCParam_units_per_rev 
NGCParam_coord_system 
NGCParam_tool_offset 
NGCParam_retract_r_plane 
NGCParam_retract_old_z 
NGCParam_spindle_rpm_mode 
NGCParam_spindle_css_mode 
NGCParam_ijk_absolute_mode 
NGCParam_lathe_diameter_mode 
NGCParam_lathe_radius_mode 
NGCParam_spindle_on 
NGCParam_spindle_cw 
NGCParam_mist 
NGCParam_flood 
NGCParam_speed_override 
NGCParam_feed_override 
NGCParam_adaptive_feed 
NGCParam_feed_hold 
NGCParam_feed 
NGCParam_rpm 
NGCParam_x 
NGCParam_y 
NGCParam_z 
NGCParam_a 
NGCParam_b 
NGCParam_c 
NGCParam_u 
NGCParam_v 
NGCParam_w 
NGCParam_abs_x 
NGCParam_abs_y 
NGCParam_abs_z 
NGCParam_abs_a 
NGCParam_abs_b 
NGCParam_abs_c 
NGCParam_abs_u 
NGCParam_abs_v 
NGCParam_abs_w 
NGCParam_current_tool 
NGCParam_current_pocket 
NGCParam_selected_tool 
NGCParam_selected_pocket 
NGCParam_call_level 
NGCParam_Last 

Function Documentation

◆ ngc_call_level()

uint_fast8_t ngc_call_level ( void  )

◆ ngc_call_pop()

bool ngc_call_pop ( void  )

◆ ngc_call_push()

bool ngc_call_push ( void *  context)

◆ ngc_float_decimals()

uint8_t ngc_float_decimals ( void  )

◆ ngc_modal_state_invalidate()

void ngc_modal_state_invalidate ( void  )

◆ ngc_modal_state_restore()

bool ngc_modal_state_restore ( void  )

◆ ngc_modal_state_save()

bool ngc_modal_state_save ( gc_modal_t state,
bool  auto_restore 
)

◆ ngc_named_param_exists()

bool ngc_named_param_exists ( char *  name)

◆ ngc_named_param_get()

bool ngc_named_param_get ( char *  name,
float *  value 
)

◆ ngc_named_param_get_by_id()

float ngc_named_param_get_by_id ( ncg_name_param_id_t  id)

◆ ngc_named_param_set()

bool ngc_named_param_set ( char *  name,
float  value 
)

◆ ngc_param_exists()

bool ngc_param_exists ( ngc_param_id_t  id)

◆ ngc_param_get()

bool ngc_param_get ( ngc_param_id_t  id,
float *  value 
)

◆ ngc_param_is_rw()

bool ngc_param_is_rw ( ngc_param_id_t  id)

◆ ngc_param_set()

bool ngc_param_set ( ngc_param_id_t  id,
float  value 
)