Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add API_ru #2

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

add API_ru #2

wants to merge 4 commits into from

Conversation

Greengaraj
Copy link
Collaborator

Создал API_ru

Copy link
Collaborator

@nomad605dis nomad605dis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Сделай правки, которые мы обсудили.

@Greengaraj
Copy link
Collaborator Author

Внесение изменений

Copy link
Collaborator

@nomad605dis nomad605dis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Лови правки

API_ru.md Outdated
@@ -0,0 +1,23 @@
# AmperkaLed API (RUS)

## `class led(int pin)`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## `class led(int pin)`
## `class LED(uint8_t pin)`

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Название класса всегда пишется с заглавной буквы. А т.е. LED это сокращенная запись ставим все заглавные.
  • Вряд ли номер пина будет больше 255.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
@@ -0,0 +1,23 @@
# AmperkaLed API (RUS)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# AmperkaLed API (RUS)
# AmperkaLED API (RUS)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Вроде так же назвали репу

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated

## `class led(int pin)`
Создайте объект класса `led` для работы со светодиодом.
Светодиод будет управляться напряждением, подаваемым на пин Arduino, к которому подключен светодиод.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Светодиод будет управляться напряждением, подаваемым на пин Arduino, к которому подключен светодиод.
Светодиод будет управляться напряжением, подаваемым на пин Arduino, к которому подключен светодиод.

Прогани весь текст на грамматические ошибки.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
## `class led(int pin)`
Создайте объект класса `led` для работы со светодиодом.
Светодиод будет управляться напряждением, подаваемым на пин Arduino, к которому подключен светодиод.
- `pin`: указывается номер пина, к которому подключен светодиод.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `pin`: указывается номер пина, к которому подключен светодиод.
- `pin`: номер пина, к которому подключен светодиод.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
- `pin`: указывается номер пина, к которому подключен светодиод.

### `ledOn()`
Функция объекта `led`, пшепозволяющая включить светодиод.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Функция объекта `led`, пшепозволяющая включить светодиод.
Включает светодиод.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
### `ledSet(bool state)`
Функция объекта `led`, инвертирующая состояние светодиода.

### `ledPWM(uint8_t value)`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### `ledPWM(uint8_t value)`
### `ledBrightness(uint8_t value)`

Так явно лучше

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
Функция объекта `led`, инвертирующая состояние светодиода.

### `ledPWM(uint8_t value)`
Функция объекта `led`, позволяющая управлять яркостью светодиода.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Функция объекта `led`, позволяющая управлять яркостью светодиода.
Устанавливает яркость свечения. Доступный диапазон значений яркости от `0` до `255`.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Указываем допустимые значения

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
Светодиод будет управляться напряждением, подаваемым на пин Arduino, к которому подключен светодиод.
- `pin`: указывается номер пина, к которому подключен светодиод.

### `ledOn()`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### `ledOn()`
### `turnOn()`

И так понятно, что у нас это светодиод. Сравни два кода:

// Создаём объект
LED led(3);
// Включаем светодиод
led.turnOn();
// Создаём объект
LED led(3);
// Включаем светодиод
led.ledOn();

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
### `ledOn()`
Функция объекта `led`, пшепозволяющая включить светодиод.

### `ledOff()`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### `ledOff()`
### `turnOff()`

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Уже описал выше.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
### `ledPWM(uint8_t value)`
Функция объекта `led`, позволяющая управлять яркостью светодиода.

### `ledToogle(float timeOn, float timeOff)`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Зачем тут тип данных float?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Исправил

Copy link
Collaborator Author

@Greengaraj Greengaraj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Внёс правки

API_ru.md Outdated
@@ -0,0 +1,23 @@
# AmperkaLed API (RUS)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
@@ -0,0 +1,23 @@
# AmperkaLed API (RUS)

## `class led(int pin)`
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated

## `class led(int pin)`
Создайте объект класса `led` для работы со светодиодом.
Светодиод будет управляться напряждением, подаваемым на пин Arduino, к которому подключен светодиод.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
## `class led(int pin)`
Создайте объект класса `led` для работы со светодиодом.
Светодиод будет управляться напряждением, подаваемым на пин Arduino, к которому подключен светодиод.
- `pin`: указывается номер пина, к которому подключен светодиод.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
Светодиод будет управляться напряждением, подаваемым на пин Arduino, к которому подключен светодиод.
- `pin`: указывается номер пина, к которому подключен светодиод.

### `ledOn()`
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
Функция объекта `led`, позволяющая выключить светодиод.

### `ledSet(bool state)`
Функция объекта `led`, инвертирующая состояние светодиода.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
### `ledSet(bool state)`
Функция объекта `led`, инвертирующая состояние светодиода.

### `ledPWM(uint8_t value)`
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
Функция объекта `led`, инвертирующая состояние светодиода.

### `ledPWM(uint8_t value)`
Функция объекта `led`, позволяющая управлять яркостью светодиода.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
- `pin`: указывается номер пина, к которому подключен светодиод.

### `ledOn()`
Функция объекта `led`, пшепозволяющая включить светодиод.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Принял

API_ru.md Outdated
### `ledPWM(uint8_t value)`
Функция объекта `led`, позволяющая управлять яркостью светодиода.

### `ledToogle(float timeOn, float timeOff)`
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Исправил

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants