Skip to content

Commit 0a0e626

Browse files
authored
Update README.md
1 parent b63a363 commit 0a0e626

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,27 @@
11
# AtTiny85-Arduino-Serial-Monitor
22

3-
Serial interface for ATTiny that allows you to print different data types to an arduino's serial monitor. Doesn't require any extra serial cables/devices. This uses Software Serial so it's not all too lightweight.
3+
Serial interface for ATTiny that allows you to print different data types to an arduino's serial monitor. Doesn't require any extra serial cables/devices. This uses SoftwareSerial so it's not all too lightweight.
44

55
## Setting up
66

77
These instructions assume you are already able to upload code to your ATTiny using the Arduino IDE. For a good tutorial on how to do that check out [this](https://create.arduino.cc/projecthub/arjun/programming-attiny85-with-arduino-uno-afb829).
88

99
### Installation
10-
The library has to be downloaded as three seperate "libraries" due to the way that things are compiled. To do so:
10+
The library has to be downloaded as three seperate libraries.
1111
- Download [this zip file](https://github.com/davidOSUL/AtTiny85-Arduino-Serial-Monitor/raw/master/AtTiny85-Arduino-Serial-Monitor.zip) (also avaialble in releases tab).
1212
- Unzip this file. Inside are three more zip files.
13-
For all three of these zip files, do the following:
14-
- Using Arduino IDE 1.0.x:
15-
- **Sketch > Import Library... > Add Library... >** select the zip file **> Open**
16-
- Using Arduino IDE 1.5+:
17-
- **Sketch > Include Library > Add ZIP Library... >** select the zip file **> Open**
13+
- For **each** of these zip files, do the following:
14+
- Using Arduino IDE 1.0.x:
15+
- **Sketch > Import Library... > Add Library... >** select the zip file **> Open**
16+
- Using Arduino IDE 1.5+:
17+
- **Sketch > Include Library > Add ZIP Library... >** select the zip file **> Open**
18+
19+
After doing this, when you go to your list of libraries (**Sketch> Include Library**), you should see the following libraries included:
20+
```
21+
ArduinoSerialIn
22+
SerialTypes
23+
TinySerialOut
24+
```
1825

1926
## Using the Library
2027
- The code uploaded to your Tiny will allow you to write out data
@@ -38,14 +45,16 @@ For more details on using these functions see [**TinySerialOut Details**](https:
3845
Once you've uploaded your code to your Tiny, and the provided code to your arduino, you'll need to connect the two.
3946

4047

41-
You'll want to hook up your designated TX pin on your Tiny to the Arduino's RX Pin with a 330 ohm resistor in series. Then hook up the Tiny's Voltage pin to 5V and GND to GND.
48+
You'll want to hook up your designated TX pin on your Tiny to the Arduino's RX Pin with a 330 ohm resistor in series. Then hook up the Tiny's Voltage pin to 5V and GND to GND.
49+
50+
The schematic shown uses the same TX pin on the Tiny as used in the included examples:
4251
![scehmatic](https://github.com/davidOSUL/AtTiny85-Arduino-Serial-Monitor/blob/master/schematic.jpg)
4352

44-
This library uses one way communication (Tiny -> Arduino), so it only needs one pin on the Tiny for serial communication.
45-
The schematic shown uses the same pin numbers as used in the included examples, but any of the digital pins should work.
53+
- This library uses one way communication (Tiny -> Arduino), which is why it only needs one pin on the Tiny for serial communication.
54+
4655
### Putting everything together: Reading Serial Data
4756
Once you've uploaded the correct code to your arduino as described in [**Setting Up the Arduino**](https://github.com/davidOSUL/AtTiny85-Arduino-Serial-Monitor#setting-up-the-arduino), and you've uploaded code
48-
to your Tiny that contains some serial output, and wired everything together:
57+
to your Tiny that contains some serial output, and [wired](https://github.com/davidOSUL/AtTiny85-Arduino-Serial-Monitor/#wiring) everything together:
4958
1. Power on the Arduino
5059
2. Make sure that you have the port (**Tools > Port**) corresponding to the Arduino selected
5160
3. **Wait a second or two**. if you open up the Serial Monitor straight away, you may be met with no output. If you then try
@@ -55,7 +64,11 @@ to close it and open it again, most likely you'll get bad values, and you'll hav
5564

5665
## Other Notes
5766
### TinySerialOut Details
58-
To write serial data from your Tiny include `TinySerialOut.h` in the code that you upload to your Tiny. Create a new TinySerialOut object, and pass in to the constructor the **digital** pin on the Tiny you are using for serial output. Note that this is not the hardware pin, the number you should use in code should correspond to the light-blue numbers below:
67+
To write serial data from your Tiny include `TinySerialOut.h` in the code that you upload to your Tiny:
68+
- Create a new TinySerialOut object.
69+
- Pass in to the constructor the **digital** pin on the Tiny you are using for serial output.
70+
- Note that this is not the hardware pin, the number you should use in code should correspond to the light-blue numbers below:
71+
5972
![pinout](pinout.png)
6073

6174
The TinySerialOut object contains two groups of functions to use.

0 commit comments

Comments
 (0)