protocol.h File Reference

#include "task.h"

Go to the source code of this file.

Data Structures
union	fg_task_ptr

Macros
#define	LINE_BUFFER_SIZE   257

Functions
bool	protocol_main_loop (void)
bool	protocol_execute_realtime (void)
bool	protocol_exec_rt_system (void)
void	protocol_execute_noop (uint_fast16_t state)
bool	protocol_enqueue_rt_command (on_execute_realtime_ptr fn)
	Enqueue a function to be called once by the foreground process. More...
bool	protocol_enqueue_foreground_task (fg_task_ptr fn, void *data)
	Enqueue a function to be called once by the foreground process. More...
void	protocol_auto_cycle_start (void)
bool	protocol_buffer_synchronize (void)
bool	protocol_enqueue_realtime_command (char c)
bool	protocol_enqueue_gcode (char *data)
void	protocol_message (char *message)

Macro Definition Documentation

LINE_BUFFER_SIZE

#define LINE_BUFFER_SIZE   257

Function Documentation

protocol_auto_cycle_start()

void protocol_auto_cycle_start

(

void

)

protocol_buffer_synchronize()

bool protocol_buffer_synchronize

(

void

)

protocol_enqueue_foreground_task()

bool protocol_enqueue_foreground_task	(	fg_task_ptr	fn,
		void *	data
	)

Enqueue a function to be called once by the foreground process.

Parameters

fn	pointer to a foreground_task_ptr type of function.
data	pointer to data to be passed to the callee.

Returns

true if successful, false otherwise.

protocol_enqueue_gcode()

bool protocol_enqueue_gcode

(

char *

data

)

protocol_enqueue_realtime_command()

bool protocol_enqueue_realtime_command

(

char

c

)

protocol_enqueue_rt_command()

bool protocol_enqueue_rt_command

(

on_execute_realtime_ptr

fn

)

Enqueue a function to be called once by the foreground process.

Parameters

fn	pointer to a on_execute_realtime_ptr type of function.

Returns

true if successful, false otherwise. NOTE: Deprecated, use protocol_enqueue_foreground_task instead.

protocol_exec_rt_system()

bool protocol_exec_rt_system

(

void

)

protocol_execute_noop()

void protocol_execute_noop

(

uint_fast16_t

state

)

protocol_execute_realtime()

bool protocol_execute_realtime

(

void

)

protocol_main_loop()

bool protocol_main_loop

(

void

)

protocol_message()

void protocol_message

(

char *

message

)