Руководство пользователя

Часть рабочей документации уже написана – это постановка задачи, алгоритм, список локальных переменных и исходный текст.

Постановка задачи описывает, что мы ждём от драйвера в терминах робота.

Алгоритм позволяет понять, как драйвер работает, так сказать, относительно крупными шагами. Вы, наверное, обратили внимание, что в алгоритме практически не упоминаются операторы языка – только действия с переменными, которые исполняются.

В нашем варанте в алгоритме не упомянуты декларирования внутренних параметров управления двигателями и ограничителями. Попробуйте у себя в рабочей тетради скопировать наш алгоритм, но добавив эти действия.

Вторая часть рабочей документации – Исходный текст (иногда говорят – листинг) программы. В листинге указывается каждый оператор, и даются комментарии ко многим операторам. Листинг полезен для тех, кто хочет подробно разобраться, как устроена программа и, может быть, изменить её исходный код под свои требования.

Третья часть документации – Руководство пользователя. Это краткий текст для тех, кто хочет просто использовать готовую программу как часть своего проекта, но подробно разбираться, как она работает, нет ни времени, ни желания.

Руководство состоит из двух частей ОПИСАНИЕ и СИНТАКСИС.

ОПИСАНИЕ

При вызове драйвер DRIVER_Motor_Shield_Control (int _left_power, int _right_power) производит загрузку четырёх портов вывода платы Arduino UNO сигналами, обеспечивающими вращение колёс робота через плату управления MotorShield в соответствии с электрической разводкой этой платы. Задействуются следующие контакты платы Arduino UNO – 4, 5, 6 и 7. Использование этих контактов для других устройств запрещено.

СИНТАКСИС

DRIVER_Motor_Shield_Control (value_1, value_2);   – где value_1 и value_2 это целые числа со знаком, обозначающие направление и скорость вращения колёс робота. Знак плюс соответствует движению вперёд, знак минус – назад, value_1 это скорость вращения левого колеса, value_2 – правого. При превышении модуля value_1 или value_2 максимально возможного числа = 250, в моторы подаётся 250. Если модуль меньше 250, то в моторы подаётся модуль полученного числа.