esc_stick_int.h File Reference

Stick programming: what esc_stick.c, esc_stick_rules.c and esc_det.c share and esc_stick.h does not publish. More...

#include <stdbool.h>
#include "esc_stick.h"

Go to the source code of this file.

Functions
void	esc_det_drop_group (esc_det_t *d)
	Forget any group under way, as if the line had been silent.
void	esc_det_floor_only (esc_det_t *d)
	Floor only: no pulses, no groups.
bool	esc_stick_no (const char **why, const char *text)
	Set *why to text when why is not NULL, and return false.

Detailed Description

Stick programming: what esc_stick.c, esc_stick_rules.c and esc_det.c share and esc_stick.h does not publish.

For shared/esc only.

SPDX-License-Identifier: MIT

Function Documentation

esc_det_drop_group()

void esc_det_drop_group

(

esc_det_t *

d

)

Forget any group under way, as if the line had been silent.

In esc_det.c.

Parameters

d	The beep detector.

esc_det_floor_only()

void esc_det_floor_only

(

esc_det_t *

d

)

Floor only: no pulses, no groups.

In esc_det.c.

Parameters

d	The beep detector.

esc_stick_no()

bool esc_stick_no	(	const char **	why,
		const char *	text )

Set *why to text when why is not NULL, and return false.

In esc_stick_rules.c.

Parameters

why	Receives the reason, or NULL to set nothing.
text	The reason.

Returns

false, always.