grblHAL core  20250320
plugins.h File Reference
#include <stdint.h>
#include <stdbool.h>
#include "nvs.h"

Go to the source code of this file.

Data Structures

struct  jog_settings_t
 
union  network_services_t
 
struct  mqtt_settings_t
 
struct  network_settings_t
 
struct  network_info_t
 
struct  wifi_ap_settings_t
 
struct  wifi_sta_settings_t
 
struct  bluetooth_settings_t
 
struct  modbus_settings_t
 
struct  modbus_tcp_settings_t
 
union  encoder_event_t
 
union  encoder_flags_t
 
struct  encoder_settings_t
 
struct  encoder_t
 
struct  i2c_transfer_t
 
union  i2c_cap_t
 

Macros

#define MODBUS_TCP_SETTINGS_INCREMENT   5
 
#define DISPLAY_I2C   (1<<0)
 1 More...
 
#define DISPLAY_SPI   (1<<1)
 2 More...
 
#define DISPLAY_UART   (1<<2)
 4 More...
 
#define DISPLAY_I2C_INTERFACE   ((1<<3)|DISPLAY_I2C)
 9 - @grblhal More...
 
#define DISPLAY_I2C_LEDS   ((1<<4)|DISPLAY_I2C)
 17 - @grblhal More...
 
#define DISPLAY_I2C_OLED_1   ((1<<5)|DISPLAY_I2C)
 33 - @luc-github More...
 
#define DISPLAY_DRIVER_SH1106   1
 
#define DISPLAY_DRIVER_SSD1306   2
 
#define DISPLAY_DRIVER_SSD1331   3
 
#define DISPLAY_DRIVER_ILI9340   4
 
#define DISPLAY_DRIVER_ILI9341   5
 
#define DISPLAY_DRIVER_ILI9486   6
 
#define i2c_nvs_transfer(i2c, rd)   i2c_transfer(i2c, rd)
 
#define NVS_TransferResult_OK   true
 

Typedefs

typedef char ssid_t[65]
 
typedef uint8_t bssid_t[6]
 
typedef char username_t[33]
 
typedef char password_t[33]
 
typedef char hostname_t[33]
 
typedef char uri_t[65]
 
typedef uint_fast16_t i2c_address_t
 
typedef i2c_transfer_t nvs_transfer_t
 
typedef bool nvs_transfer_result_t
 
typedef void(* keycode_callback_ptr) (const char c)
 

Enumerations

enum  ip_mode_t { IpMode_Static = 0 , IpMode_DHCP , IpMode_AutoIP }
 
enum  grbl_wifi_mode_t { WiFiMode_NULL = 0 , WiFiMode_STA , WiFiMode_AP , WiFiMode_APSTA }
 
enum  modbus_tcp_setting_id_t { Setting_ModbusIpAddress = 0 , Setting_ModbusPort = 1 , Setting_ModbusId = 2 }
 
enum  encoder_mode_t {
  Encoder_Universal = 0 , Encoder_FeedRate , Encoder_RapidRate , Encoder_Spindle_RPM ,
  Encoder_MPG , Encoder_MPG_X , Encoder_MPG_Y , Encoder_MPG_Z ,
  Encoder_MPG_A , Encoder_MPG_B , Encoder_MPG_C , Encoder_Spindle_Position
}
 
enum  encoder_setting_id_t { Setting_EncoderMode = 0 , Setting_EncoderCPR = 1 , Setting_EncoderCPD = 2 , Setting_EncoderDblClickWindow = 3 }
 

Functions

i2c_cap_t i2c_start (void)
 
bool i2c_probe (i2c_address_t i2c_address)
 
bool i2c_send (i2c_address_t i2c_address, uint8_t *data, size_t size, bool block)
 
bool i2c_receive (i2c_address_t i2cAddr, uint8_t *buf, size_t size, bool block)
 
bool i2c_get_keycode (i2c_address_t i2c_address, keycode_callback_ptr callback)
 
bool i2c_transfer (i2c_transfer_t *i2c, bool read)
 

Macro Definition Documentation

◆ DISPLAY_DRIVER_ILI9340

#define DISPLAY_DRIVER_ILI9340   4

◆ DISPLAY_DRIVER_ILI9341

#define DISPLAY_DRIVER_ILI9341   5

◆ DISPLAY_DRIVER_ILI9486

#define DISPLAY_DRIVER_ILI9486   6

◆ DISPLAY_DRIVER_SH1106

#define DISPLAY_DRIVER_SH1106   1

◆ DISPLAY_DRIVER_SSD1306

#define DISPLAY_DRIVER_SSD1306   2

◆ DISPLAY_DRIVER_SSD1331

#define DISPLAY_DRIVER_SSD1331   3

◆ DISPLAY_I2C

#define DISPLAY_I2C   (1<<0)

1

◆ DISPLAY_I2C_INTERFACE

#define DISPLAY_I2C_INTERFACE   ((1<<3)|DISPLAY_I2C)

9 - @grblhal

◆ DISPLAY_I2C_LEDS

#define DISPLAY_I2C_LEDS   ((1<<4)|DISPLAY_I2C)

17 - @grblhal

◆ DISPLAY_I2C_OLED_1

#define DISPLAY_I2C_OLED_1   ((1<<5)|DISPLAY_I2C)

33 - @luc-github

◆ DISPLAY_SPI

#define DISPLAY_SPI   (1<<1)

2

◆ DISPLAY_UART

#define DISPLAY_UART   (1<<2)

4

◆ i2c_nvs_transfer

#define i2c_nvs_transfer (   i2c,
  rd 
)    i2c_transfer(i2c, rd)

◆ MODBUS_TCP_SETTINGS_INCREMENT

#define MODBUS_TCP_SETTINGS_INCREMENT   5

◆ NVS_TransferResult_OK

#define NVS_TransferResult_OK   true

Typedef Documentation

◆ bssid_t

typedef uint8_t bssid_t[6]

◆ hostname_t

typedef char hostname_t[33]

◆ i2c_address_t

typedef uint_fast16_t i2c_address_t

◆ keycode_callback_ptr

typedef void(* keycode_callback_ptr) (const char c)

◆ nvs_transfer_result_t

typedef bool nvs_transfer_result_t

◆ nvs_transfer_t

◆ password_t

typedef char password_t[33]

◆ ssid_t

typedef char ssid_t[65]

◆ uri_t

typedef char uri_t[65]

◆ username_t

typedef char username_t[33]

Enumeration Type Documentation

◆ encoder_mode_t

Enumerator
Encoder_Universal 
Encoder_FeedRate 
Encoder_RapidRate 
Encoder_Spindle_RPM 
Encoder_MPG 
Encoder_MPG_X 
Encoder_MPG_Y 
Encoder_MPG_Z 
Encoder_MPG_A 
Encoder_MPG_B 
Encoder_MPG_C 
Encoder_Spindle_Position 

◆ encoder_setting_id_t

Enumerator
Setting_EncoderMode 
Setting_EncoderCPR 

Count Per Revolution.

Setting_EncoderCPD 

Count Per Detent.

Setting_EncoderDblClickWindow 

◆ grbl_wifi_mode_t

Enumerator
WiFiMode_NULL 
WiFiMode_STA 
WiFiMode_AP 
WiFiMode_APSTA 

◆ ip_mode_t

enum ip_mode_t
Enumerator
IpMode_Static 
IpMode_DHCP 
IpMode_AutoIP 

◆ modbus_tcp_setting_id_t

Enumerator
Setting_ModbusIpAddress 
Setting_ModbusPort 
Setting_ModbusId 

Function Documentation

◆ i2c_get_keycode()

bool i2c_get_keycode ( i2c_address_t  i2c_address,
keycode_callback_ptr  callback 
)

◆ i2c_probe()

bool i2c_probe ( i2c_address_t  i2c_address)

◆ i2c_receive()

bool i2c_receive ( i2c_address_t  i2cAddr,
uint8_t *  buf,
size_t  size,
bool  block 
)

◆ i2c_send()

bool i2c_send ( i2c_address_t  i2c_address,
uint8_t *  data,
size_t  size,
bool  block 
)

◆ i2c_start()

i2c_cap_t i2c_start ( void  )

◆ i2c_transfer()

bool i2c_transfer ( i2c_transfer_t i2c,
bool  read 
)