Skip to content

Commit d7160d4

Browse files
committed
Added missing serial start
1 parent 78c42a3 commit d7160d4

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ICSC(Stream *d, uint8_t station, int depin);
2020
ICSC(Stream &d, uint8_t station, int depin);
2121
```
2222
23-
The `Stream` is the device you wish to communicate over. `station` is the number (or single letter code) of this station, and `depin` is, if provided, the DE/RE pin pair of a MAX485 chip or similar.
23+
The `Stream` is the device you wish to communicate over. `station` is the number (or single letter code) of this station, and `depin` is, if provided, the DE/RE pin pair of a MAX485 chip or similar. The stream device you choose must be manually configured before starting ICSC:
2424
2525
Example:
2626
@@ -31,6 +31,7 @@ ICSC icsc(Serial, 'A', 3);
3131
3232
void setup()
3333
{
34+
Serial.begin(9600);
3435
icsc.begin();
3536
}
3637
```
@@ -47,7 +48,10 @@ Register a new command to be acted upon. Calls the function commandCallback when
4748
Example:
4849
4950
```C++
50-
icsc.registerCommand('T', &tick);
51+
void setup() {
52+
// init code here
53+
icsc.registerCommand('T', &tick);
54+
}
5155
5256
void tick(unsigned char source, char command, unsigned char length, char *data)
5357
{

0 commit comments

Comments
 (0)