Модуль, реализующий функции сервисного меню

Группы
	Реализации функций меню настроек
	Функции не имеют детальных комментариев, поскольку их назначение описано в документации на сервисное меню; кроме этого, их описание приводится в строковых элементах массива menu_items.

Файлы
файл	menu_handlers.h

Структуры данных
struct	menu_item_descriptor_t
typedef void(*	menu_handler_t) (device_setup_data_t *settings)
const menu_item_descriptor_t	menu_items []
	Массив, сопоставляющий указатели на функции, реализующие опции меню настроек, и их описания Подробнее...
uint8_t	execute_AT_command (const uint8_t *atcmd)
	Вспомогательная функция. Выполняет AT-команду Подробнее...
uint8_t	execute_AT_command_silent (const uint8_t *cmd, uint8_t *response_out)
	Вспомогательная функция. Выполняет AT-команду без вывода результата в консоль Подробнее...
uint8_t	is_alphanumeric (uint8_t ch)
	Вспомогательная функция. Проверяет принадлежность символа к буквам либо цифрам. Подробнее...
void	perform_initial_setup (device_setup_data_t *settings)
	Функция, выполняющая заводскую настройку платы и радиомодуля.
#define	ITEM_DESCRIPTION_LENGTH   150

Подробное описание

Типы

menu_handler_t

typedef void(* menu_handler_t) (device_setup_data_t *settings)

Тип функции-обработчика опции сервисного меню. Такая функция принимает в качестве параметра структуру системных настроек и не имеет возвращаемого значения.

См. определение в файле menu_handlers.h строка 26

Функции

execute_AT_command()

uint8_t execute_AT_command

(

const uint8_t *

atcmd

)

Вспомогательная функция. Выполняет AT-команду

Аргументы

[in]

atcmd

- строка, содержащая AT-команду. CR-LF добавляется автоматически.

Возвращает

1 - команда выполнена успешно; 0 - команду не удалось выполнить, либо выполнение команды завершилась с ошибкой

См. определение в файле menu_handlers.c строка 16

execute_AT_command_silent()

uint8_t execute_AT_command_silent	(	const uint8_t *	cmd,
		uint8_t *	response_out
	)

Вспомогательная функция. Выполняет AT-команду без вывода результата в консоль

Аргументы

[in]	atcmd	- строка, содержащая AT-команду. CR-LF должен быть указан явно.
[out]	response_out	- буфер, в который будет помещен ответ модуля. Если анализ ответа не требуется, допускается передача NULL в качестве этого параметра.

Возвращает

1 - команда выполнена успешно; 0 - команду не удалось выполнить, либо выполнение команды завершилась с ошибкой

См. определение в файле menu_handlers.c строка 335

is_alphanumeric()

uint8_t is_alphanumeric

(

uint8_t

ch

)

Вспомогательная функция. Проверяет принадлежность символа к буквам либо цифрам.

Аргументы

[in]

ch

- символ.

Возвращает

1 - переданный символ - буква из диапазона [A...Z | a...z] либо цифра.

См. определение в файле menu_handlers.c строка 46

Переменные

menu_items

const menu_item_descriptor_t menu_items[]

Массив, сопоставляющий указатели на функции, реализующие опции меню настроек, и их описания

Функция, реализующая меню, использует информацию из этого массива для автоматического формирования списка доступных опций и вызова функций, выбранных пользователем по номеру описания.

Предупреждения

Массив должен заканчиваться элементом {NULL,"\0"}. Такой элемент служит признаком конца массива.

См. определение в файле menu_handlers.c строка 903