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	nvs_transfer_t

Macros
#define	MODBUS_TCP_SETTINGS_INCREMENT   5

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 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
nvs_transfer_result_t	i2c_nvs_transfer (nvs_transfer_t *i2c, bool read)
bool	i2c_probe (uint_fast16_t i2c_address)
bool	i2c_send (uint_fast16_t i2c_address, uint8_t *data, size_t size, bool block)
void	i2c_get_keycode (uint_fast16_t i2c_address, keycode_callback_ptr callback)

Macro Definition Documentation

MODBUS_TCP_SETTINGS_INCREMENT

#define MODBUS_TCP_SETTINGS_INCREMENT   5

Typedef Documentation

bssid_t

typedef uint8_t bssid_t[6]

hostname_t

typedef char hostname_t[33]

keycode_callback_ptr

typedef void(* keycode_callback_ptr) (const char c)

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

enum 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

enum encoder_setting_id_t

Enumerator
Setting_EncoderMode
Setting_EncoderCPR	Count Per Revolution.
Setting_EncoderCPD	Count Per Detent.
Setting_EncoderDblClickWindow

grbl_wifi_mode_t

enum 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

enum modbus_tcp_setting_id_t

Enumerator
Setting_ModbusIpAddress
Setting_ModbusPort
Setting_ModbusId

Function Documentation

i2c_get_keycode()

void i2c_get_keycode	(	uint_fast16_t	i2c_address,
		keycode_callback_ptr	callback
	)

i2c_nvs_transfer()

nvs_transfer_result_t i2c_nvs_transfer	(	nvs_transfer_t *	i2c,
		bool	read
	)

i2c_probe()

bool i2c_probe

(

uint_fast16_t

i2c_address

)

i2c_send()

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