Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aron-bordin committed Apr 8, 2015
1 parent 5494400 commit ba630b0
Show file tree
Hide file tree
Showing 5 changed files with 231 additions and 1 deletion.
25 changes: 25 additions & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# About .PNG team

.PNG Arduino Framework was developed by stutents of Unesp - University of the State of São Paulo, Brazil, with the goal to turn Arduino project development easier. The framework has a chain of modular classes, compatible with some Arduino components.

# Contact
Contact us: aron.bordin@gmail.com


# Developers

[Aron Barreira Bordin](http://github.com/aron-bordin/)

Felipe Kutait

Hugo Waki

[Mateus Lopes](https://github.com/lopeslopes)

Matheus Barbosa

[Raul Pelegrini Neto](https://github.com/RaulPelegrini)

[Vinicius Moretto](https://github.com/vinimoretto)

Vitor Costanzo
69 changes: 69 additions & 0 deletions docs/bluetooth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
## Bluetooth

This module can be used to send and receive bluetooth data. If you want to connect your Arduino with a Bluetooth device, Arduino or any other, check the Helpers module to find some classes that will help you to connect them.
This module was tested with:

* BC417 Bluetooth to Serial
* Bluetooth-RS232 HC-05

It'll probably work with similar components. If you test it a component not listed here, please add a comment in my blog, open a pull request or edit this file to share if it's working or if you are getting some error.


## Example

Include the library
```c++
#include "Bluetooth.h"
```

Create a new Bluetooth object
```c++
Bluetooth *blue = new Bluetooth(5, 6);
```

Add the following method in **void setup()**:
```c++
blue->setupBluetooth();
```
Now you can use any method on **void loop()**:
```c++
String msg = blue->read(); // read and receive a message
blue->send("I'm sending a message");
```
## Methods
**Bluetooth(int r, int t);** - Create a new Bluetooth object with RX and TX PINs
**int getrxPin();** - Get the RX PIN
**int gettxPin();** - Get the TX PIN
**char * getPIN();** - Get Bluetooth PIN
**char * read();** - Read and receive a message
**char * getName();** - Get the Bluetooth device name
**char getMessageEnd();** - Get the char that means 'end of string'
**void setMessageEnd(char end);** - Set the char that mean 'end of string'
**void setName(char name[]);** - Set Bluetooth device name
**void setrxPin(int rx);** - Set RX PIN
**void settxPin(int tx);** - Set TX PIN
**void setupBluetooth();** - Setup the Bluetooth module
**void send(char c[]);** - Send a message
**void setPIN(int pin);** - Set bluetooth PIN
## Contribute
This library still under development. We need help adding new components and testing with differents Arduino and components versions.
Any help will be appreciated :)
55 changes: 55 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
PNG-Arduino-Framework - Beta 0.1
================================

.PNG - Programmers of New Generation


## About

.PNG Arduino Framework was developed by stutents of Unesp - University of the State of São Paulo, Brazil, with the goal to turn Arduino project development easier. The framework has a chain of modular classes, compatible with some Arduino components.


## Roadmap

We have to organize all modules, write some tutorials and publish it. It will take some time...


## Libraries

This version supports some Arduino components:
* Bluetooth
* [LED Matrix - 74HC595/74HC138](http://www.elabpeers.com/led-matrix-display.html)


## Tutorials
* Bluetooth:
* [How to connect an Android device with Arduino and bluetooth](https://bytedebugger.wordpress.com/2014/06/27/tutorial-how-to-connect-an-android-device-with-arduino-and-bluetooth/)

* LED Matrix:
* [How to use Dot LED Matrix Display with Arduino](https://bytedebugger.wordpress.com/2015/01/28/tutorial-how-to-use-dot-led-matrix-display-with-arduino/)
* [Flappy Duino – Creating an Arduino clone of Flappy Bird with LED Matrix](https://bytedebugger.wordpress.com/2015/01/29/flappy-duino-creating-an-arduino-clone-of-flappy-bird-with-led-matrix/)


## Contribute

This library still under development. We need help adding new components and testing with differents Arduino and components versions.
Any help will be appreciated :)


## About .PNG team

[Aron Barreira Bordin](http://github.com/aron-bordin/)

Felipe Kutait

Hugo Waki

[Mateus Lopes](https://github.com/lopeslopes)

Matheus Barbosa

[Raul Pelegrini Neto](https://github.com/RaulPelegrini)

[Vinicius Moretto](https://github.com/vinimoretto)

Vitor Costanzo
81 changes: 81 additions & 0 deletions docs/led_matrix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
LED Matrix
==========


This module will help you to work with [16x16 LED Matrix with Arduino](http://www.elabpeers.com/led-matrix-display.html).

You can read the full tutorial here: https://bytedebugger.wordpress.com/2015/01/28/tutorial-how-to-use-dot-led-matrix-display-with-arduino/


Tutorials
---------

* [How to use Dot LED Matrix Display with Arduino](https://bytedebugger.wordpress.com/2015/01/28/tutorial-how-to-use-dot-led-matrix-display-with-arduino/)
* [Flappy Duino – Creating an Arduino clone of Flappy Bird with LED Matrix](https://bytedebugger.wordpress.com/2015/01/29/flappy-duino-creating-an-arduino-clone-of-flappy-bird-with-led-matrix/)


Example
-------

```c++

#include "LedMatrixObject.h"


LedMatrixObject *led = new LedMatrixObject(2, 3, 4, 5, 6, 7, 8, 9);

unsigned char Scene[16][16] = {
{1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1},
{1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 1},
{1, 1, 0, 0, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1},
{1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 1},
{1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1},
{1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1},
};

void setup(){

}

void loop(){
led->setScene(Scene);
led->setLedOn(0, 0);
led->setLedOff(8, 5);
led->draw();
}
```
Documentation
-------------
**LedMatrixObject(byte LEDARRAY_D, byte LEDARRAY_C, byte LEDARRAY_B, byte LEDARRAY_A, byte LEDARRAY_G, byte LEDARRAY_DI, byte LEDARRAY_CLK, byte LEDARRAY_LAT);** - Create the LED matrix
**void clear();** - clear the scene
**void draw();** - draw the scene on the led matrix - call it on loop()
**void setScene(unsigned char Scene[16][16]);** - set and Scene[16][16]
**void setLedOn(int x, int y);** - Turn on the led x, y on
**void setLedOff(int x, int y);** - Turn off the led x,y
**void toggleLed(int x, int y);** - Toggle the state of the led x,y
Contribute
----------
This library still under development. We need help adding new components and testing with differents Arduino and components versions.
Any help will be appreciated :)
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
site_name: My Docs
site_name: .PNG Arduino Framework

0 comments on commit ba630b0

Please sign in to comment.