Skip to content

Commit 464778f

Browse files
vishnumaieavishnumaiea
committed
v1.0.9
* Updated documentation.
1 parent 49c61f3 commit 464778f

File tree

6 files changed

+7
-215
lines changed

6 files changed

+7
-215
lines changed

‎README.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:repository-owner: CIRCUITSTATE
22
:repository-name: CSE_ArduinoRS485
3-
:repository-version: 1.0.8
3+
:repository-version: 1.0.9
44

55
= {repository-name} Library for Arduino =
66

‎docs/api.md‎

Lines changed: 0 additions & 208 deletions
Original file line numberDiff line numberDiff line change
@@ -71,22 +71,6 @@ None.
7171

7272
None.
7373

74-
#### See also
75-
76-
* [begin()](#begin)
77-
* [available()](#available)
78-
* [peek()](#peek)
79-
* [read()](#read)
80-
* [write()](#write)
81-
* [flush()](#flush)
82-
* [beginTransmission()](#begintransmission)
83-
* [endTransmission()](#endtransmission)
84-
* [receive()](#receive)
85-
* [noReceive()](#noreceive)
86-
* [sendBreak()](#sendbreak)
87-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
88-
* [setPins()](#setpins)
89-
9074
### `available()`
9175

9276
Get the number of bytes (characters) available for reading from the RS485 port. This is data that already arrived and is stored in the serial receive buffer.
@@ -105,22 +89,6 @@ None.
10589

10690
The number of bytes available to read.
10791

108-
#### See also
109-
110-
* [begin()](#begin)
111-
* [end()](#end)
112-
* [peek()](#peek)
113-
* [read()](#read)
114-
* [write()](#write)
115-
* [flush()](#flush)
116-
* [beginTransmission()](#begintransmission)
117-
* [endTransmission()](#endtransmission)
118-
* [receive()](#receive)
119-
* [noReceive()](#noreceive)
120-
* [sendBreak()](#sendbreak)
121-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
122-
* [setPins()](#setpins)
123-
12492
### `peek()`
12593

12694
Returns the next byte (character) of the incoming serial data without removing it from the internal serial buffer. That is, successive calls to peek() will return the same character, as will the next call to read().
@@ -139,22 +107,6 @@ None.
139107

140108
The first byte of incoming serial data available or -1 if no data is available.
141109

142-
#### See also
143-
144-
* [begin()](#begin)
145-
* [end()](#end)
146-
* [available()](#available)
147-
* [read()](#read)
148-
* [write()](#write)
149-
* [flush()](#flush)
150-
* [beginTransmission()](#begintransmission)
151-
* [endTransmission()](#endtransmission)
152-
* [receive()](#receive)
153-
* [noReceive()](#noreceive)
154-
* [sendBreak()](#sendbreak)
155-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
156-
* [setPins()](#setpins)
157-
158110
### `read()`
159111

160112
Reads incoming serial data.
@@ -173,22 +125,6 @@ None.
173125

174126
The first byte of incoming serial data available or -1 if no data is available.
175127

176-
#### See also
177-
178-
* [begin()](#begin)
179-
* [end()](#end)
180-
* [available()](#available)
181-
* [peak()](#peak)
182-
* [write()](#write)
183-
* [flush()](#flush)
184-
* [beginTransmission()](#begintransmission)
185-
* [endTransmission()](#endtransmission)
186-
* [receive()](#receive)
187-
* [noReceive()](#noreceive)
188-
* [sendBreak()](#sendbreak)
189-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
190-
* [setPins()](#setpins)
191-
192128
### `write()`
193129

194130
Writes binary data to the serial port. This data is sent as a byte or series of bytes.
@@ -207,22 +143,6 @@ RS485.write (uint8_t b)
207143

208144
The number of bytes written.
209145

210-
#### See also
211-
212-
* [begin()](#begin)
213-
* [end()](#end)
214-
* [available()](#available)
215-
* [peak()](#peak)
216-
* [read()](#write)
217-
* [flush()](#flush)
218-
* [beginTransmission()](#begintransmission)
219-
* [endTransmission()](#endtransmission)
220-
* [receive()](#receive)
221-
* [noReceive()](#noreceive)
222-
* [sendBreak()](#sendbreak)
223-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
224-
* [setPins()](#setpins)
225-
226146
### `flush()`
227147

228148
Waits for the transmission of outgoing serial data to complete.
@@ -241,22 +161,6 @@ None.
241161

242162
None.
243163

244-
#### See also
245-
246-
* [begin()](#begin)
247-
* [end()](#end)
248-
* [available()](#available)
249-
* [peak()](#peak)
250-
* [read()](#write)
251-
* [write()](#write)
252-
* [beginTransmission()](#begintransmission)
253-
* [endTransmission()](#endtransmission)
254-
* [receive()](#receive)
255-
* [noReceive()](#noreceive)
256-
* [sendBreak()](#sendbreak)
257-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
258-
* [setPins()](#setpins)
259-
260164
### `beginTransmission()`
261165

262166
Enables RS-485 transmission. This will assert the DE pin and the RE pin is not modified (since DE has priority over RE).
@@ -275,22 +179,6 @@ None.
275179

276180
None.
277181

278-
#### See also
279-
280-
* [begin()](#begin)
281-
* [end()](#end)
282-
* [available()](#available)
283-
* [peak()](#peak)
284-
* [read()](#write)
285-
* [write()](#write)
286-
* [flush()](#flush)
287-
* [endTransmission()](#endtransmission)
288-
* [receive()](#receive)
289-
* [noReceive()](#noreceive)
290-
* [sendBreak()](#sendbreak)
291-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
292-
* [setPins()](#setpins)
293-
294182
### `endTransmission()`
295183

296184
Disables RS-485 transmission. This deasserts the DE pin and the RE pin is not modified (since DE has priority over RE).
@@ -309,22 +197,6 @@ None.
309197

310198
None.
311199

312-
#### See also
313-
314-
* [begin()](#begin)
315-
* [end()](#end)
316-
* [available()](#available)
317-
* [peak()](#peak)
318-
* [read()](#write)
319-
* [write()](#write)
320-
* [flush()](#flush)
321-
* [beginTransmission()](#begintransmission)
322-
* [receive()](#receive)
323-
* [noReceive()](#noreceive)
324-
* [sendBreak()](#sendbreak)
325-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
326-
* [setPins()](#setpins)
327-
328200
### `receive()`
329201

330202
Enables reception. This asserts the RE pin. The state of the DE pins should be set to LOW before calling this function.
@@ -343,22 +215,6 @@ None.
343215

344216
None.
345217

346-
#### See also
347-
348-
* [begin()](#begin)
349-
* [end()](#end)
350-
* [available()](#available)
351-
* [peak()](#peak)
352-
* [read()](#write)
353-
* [write()](#write)
354-
* [flush()](#flush)
355-
* [beginTransmission()](#begintransmission)
356-
* [endTransmission()](#endtransmission)
357-
* [noReceive()](#noreceive)
358-
* [sendBreak()](#sendbreak)
359-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
360-
* [setPins()](#setpins)
361-
362218
### `noReceive()`
363219

364220
Disables reception. This deasserts the RE pin. If the DE pin is also deasserted (LOW), then the transceiver enters a high-impedance state.
@@ -377,22 +233,6 @@ None.
377233

378234
None.
379235

380-
#### See also
381-
382-
* [begin()](#begin)
383-
* [end()](#end)
384-
* [available()](#available)
385-
* [peak()](#peak)
386-
* [read()](#write)
387-
* [write()](#write)
388-
* [flush()](#flush)
389-
* [beginTransmission()](#begintransmission)
390-
* [endTransmission()](#endtransmission)
391-
* [receive()](#receive)
392-
* [sendBreak()](#sendbreak)
393-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
394-
* [setPins()](#setpins)
395-
396236
### `sendBreak()`
397237

398238
Sends a serial break signal for the specified duration in milliseconds. This function will only work if the TX pin is specified in the constructor. The serial port will be reinitialized only if the baudrate is greater than 0.
@@ -411,22 +251,6 @@ RS485.sendBreak (unsigned int duration)
411251

412252
None.
413253

414-
#### See also
415-
416-
* [begin()](#begin)
417-
* [end()](#end)
418-
* [available()](#available)
419-
* [peak()](#peak)
420-
* [read()](#write)
421-
* [write()](#write)
422-
* [flush()](#flush)
423-
* [beginTransmission()](#begintransmission)
424-
* [endTransmission()](#endtransmission)
425-
* [receive()](#receive)
426-
* [noReceive()](#noreceive)
427-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)
428-
* [setPins()](#setpins)
429-
430254
### `sendBreakMicroseconds()`
431255

432256
Sends a serial break signal for the specified duration in microseconds. This function will only work if the TX pin is specified in the constructor. The serial port will be reinitialized only if the baudrate is greater than 0.
@@ -445,22 +269,6 @@ RS485.sendBreak (unsigned int duration)
445269

446270
None.
447271

448-
#### See also
449-
450-
* [begin()](#begin)
451-
* [end()](#end)
452-
* [available()](#available)
453-
* [peak()](#peak)
454-
* [read()](#write)
455-
* [write()](#write)
456-
* [flush()](#flush)
457-
* [beginTransmission()](#begintransmission)
458-
* [endTransmission()](#endtransmission)
459-
* [receive()](#receive)
460-
* [noReceive()](#noreceive)
461-
* [sendBreak()](#sendbreak)
462-
* [setPins()](#setpins)
463-
464272
### `setPins()`
465273

466274
Modify the pins used to communicate with the RS-485 transceiver.
@@ -480,19 +288,3 @@ RS485.setPins (int dePin, int rePin, int txPin)
480288
#### Returns
481289

482290
None.
483-
484-
#### See also
485-
486-
* [begin()](#begin)
487-
* [end()](#end)
488-
* [available()](#available)
489-
* [peak()](#peak)
490-
* [read()](#write)
491-
* [write()](#write)
492-
* [flush()](#flush)
493-
* [beginTransmission()](#begintransmission)
494-
* [endTransmission()](#endtransmission)
495-
* [receive()](#receive)
496-
* [noReceive()](#noreceive)
497-
* [sendBreak()](#sendbreak)
498-
* [sendBreakMicroseconds()](#sendbreakmicroseconds)

‎library.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"url": "https://github.com/CIRCUITSTATE",
1414
"maintainer": true
1515
},
16-
"version": "1.0.8",
16+
"version": "1.0.9",
1717
"license": "LGPL-2.1",
1818
"frameworks": "arduino",
1919
"platforms": "*"

‎library.properties‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=CSE_ArduinoRS485
2-
version=1.0.8
2+
version=1.0.9
33
author=CIRCUITSTATE
44
maintainer=CIRCUITSTATE <@circuitstate>
55
sentence=Allows sending and receiving data through the RS-485 interface, using any Arduino-compatible boards.

‎src/CSE_RS485.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
*/
2121
//===================================================================================//
2222

23-
// Version: 1.0.8
24-
// Last modified: +05:30 20:34:29 PM 25-07-2023, Tuesday
23+
// Version: 1.0.9
24+
// Last modified: +05:30 20:37:44 PM 25-07-2023, Tuesday
2525
// Source: https://github.com/CIRCUITSTATE/CSE_ArduinoRS485
2626

2727
//===================================================================================//

‎src/CSE_RS485.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
*/
2121
//===================================================================================//
2222

23-
// Version: 1.0.8
24-
// Last modified: +05:30 20:34:26 PM 25-07-2023, Tuesday
23+
// Version: 1.0.9
24+
// Last modified: +05:30 20:37:40 PM 25-07-2023, Tuesday
2525
// Source: https://github.com/CIRCUITSTATE/CSE_ArduinoRS485
2626

2727
//===================================================================================//

0 commit comments

Comments
 (0)