Skip to content

Make a clean README.md #24

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Make a clean README.md #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b12281d
Make a clean README.md
cleveHEX Apr 22, 2019
ae843e6
Merge branch 'master' into CornyjK-clean-readme
cleveHEX May 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 4 additions & 56 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,62 +2,10 @@

Library for the [ArduinoLearningKitStarter (ALKS) board](https://github.com/RoboticsBrno/ArduinoLearningKitStarter/) by RoboticsBrno with definition of pins and initialization of peripheries ([wiki](https://github.com/RoboticsBrno/ArduinoLearningKitStarter/wiki)).

## Available in library managers
## How to install

### Arduino Library Manager
Installation with [Arduino IDE](https://github.com/RoboticsBrno/ArduinoLearningKitStarter/wiki/Installation-with-Arduino-IDE) or [PlatformIO](https://github.com/RoboticsBrno/ArduinoLearningKitStarter/wiki/Installation-with-PlatformIO).

Available at the Arduino Library Manager in Arduino IDE. To access it type `CTRL` + `SHIFT` + `I` or `Sketch` -> `Include Library` -> `Manage Libraries..` and type `ALSK` or `ArduinoLearningKitStarter`. If you find the library, click on install button.
## Using this library

### [PlatformIO Library Manager](https://platformio.org/lib/show/1745/ArduinoLearningKitStarter/)

Available with PlatformIO - [instalation steps](https://platformio.org/lib/show/1745/ArduinoLearningKitStarter/installation).

## Available methods

- `void setupLeds()` - sets the pins for LEDs to output
- `void setupRgbLeds()` - sets the pins for RGB LEDs to output
- `void setupButtons()` - sets the pins for buttons to input with pull-up
- `void setupPiezo()` - sets the pins for piezo to output
- `void setupAll()` - calls all previous functions

[Source code for the methods](https://github.com/RoboticsBrno/ArduinoLearningKitStarter-library/blob/master/src/ALKS.cpp)

## Available pins
Definition of pins, which are possible to use on board ALKS ([PDF with pinout on board](https://github.com/RoboticsBrno/ArduinoLearningKitStarter/blob/master/docs/pinout.pdf)).

### LEDs
- `L_R` or `LED_RED`
- `L_G` or `LED_GREEN`
- `L_Y` or `LED_YELLOW`
- `L_B` or `LED_BLUE`
- `L_RGB_R` or `LED_RGB_RED`
- `L_RGB_G` or `LED_RGB_GREEN`
- `L_RGB_B` or `LED_RGB_BLUE`

### Servos
- `S1` or `SERVO1`
- `S2` or `SERVO2`
- `S3` or `SERVO3`
- `S4` or `SERVO4`
- `S5` or `SERVO5`

### Switches/Buttons
- `SW1`
- `SW2`
- `SW3`

### Potentiometers
- `POT1`
- `POT2`

### Piezo
- `PIEZO1`
- `PIEZO2`

### Photoresistor
- `PHOTO`

### DHT11 pin
- `DHT_PIN`

[Source code for the pins definition](https://github.com/RoboticsBrno/ArduinoLearningKitStarter-library/blob/master/src/ALKS.h)
Available [functions](https://github.com/RoboticsBrno/ArduinoLearningKitStarter/wiki/Available-functions) and [pin definitions](https://github.com/RoboticsBrno/ArduinoLearningKitStarter/wiki/Pinout-en), [example](https://github.com/RoboticsBrno/ArduinoLearningKitStarter/wiki/First-program) is also available.