NeoICSerial

KO | EN

gitlite — search

#python #react #ai #machine-learning #rust #docker #awesome #cli #kubernetes #vue #pytorch #security #openai #mcp

(★ 16)

Arduino AltSoftSerial with attachInterrupt for RX chars

NeoICSerial Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

The **NeoICSerial** class is intended as a drop-in replacement for Paul Stoffregen's class [AltSoftSerial](https://github.com/PaulStoffregen/AltSoftSerial).  It adds the capability to register a function to be called when a new character is received or when all character have been transmitted.

This class can only use one predefined Input Capture pin.  Each MCU and board has a pre-determined pin:

<table><tr><td> <b>Board</b> </td><td align=center> <b>Transmit</b> </td><td align=center> <b>Receive</b> </td><td align=center> <b>PWM Unusable</b></td></tr>
<tr><td> Teensy 3.0 & 3.1 </td><td align=center> 21 </td><td align=center> 20 </td><td align=center> 22</td></tr>
<tr><td> Teensy 2.0 </td><td align=center> 9  </td><td align=center> 10 </td><td align=center> (none)</td></tr>
<tr><td> Teensy++ 2.0 </td><td align=center> 25 </td><td align=center> 4 </td><td align=center> 26, 27</td></tr>
<tr><td> Arduino Uno </td><td align=center> 9  </td><td align=center> 8 </td><td align=center> 10</td></tr>
<tr><td> Arduino Leonardo </td><td align=center> 5 </td><td align=center> 13 </td><td align=center> (none)</td></tr>
<tr><td> Arduino Mega </td><td align=center> 46 </td><td align=center> 48 </td><td align=center> 44, 45</td></tr>
<tr><td> Wiring-S </td><td align=center> 5 </td><td align=center> 6 </td><td align=center> 4</td></tr>
<tr><td> Sanguino </td><td align=center> 13 </td><td align=center> 14 </td><td align=center> 12</td></tr>
</table>

If the Input Capture pin is not available, you may want to consider [NeoHWSerial](https://github.com/SlashDevin/NeoHWSerial) or [NeoSWSerial](https://github.com/SlashDevin/NeoSWSerial).

# RX character interrupt

To handle received characters with your procedure, you must register it with the `NeoICSerial` class or your instance:

#include <NeoICSerial.h>
    NeoICSerial serial_port;

volatile uint32_t newlines = 0UL;

static void handleRxChar( uint8_t c )
    {
      if (c == '\n')
        newlines++;
    }

void setup()
    {
      serial_port.attachInterrupt( handleRxChar );
      //  OR   NeoICSerial::attachInterrupt( handleRxChar );
      serial_port.begin( 9600 );
    }

The registered procedure will be called from the ISR whenever a character is received.  The received character **will not** be stored in the `rx_buffer`, and it **will not** be returned from `read()`.  Any characters that were received and buffered before `attachInterrupt` was called remain in `rx_buffer`, and could be retrieved by calling `read()`.

If `attachInterrupt` is never called, or it is passed a `NULL` procedure, the normal buffering occurs, and all received characters must be obtained by calling `read()`.

# TX complete interrupt

To detect when all characters have been transmitted, you must register it with the `NeoICSerial` class or your instance:

```
  NeoICSerial serial_port;
  NeoICSerial::attachTxCompleteInterrupt( handleTxComplete );
     //  OR
  serial_port.attachTxCompleteInterrupt( handleTxComplete );
```

Remember that these registered procedures are called from an interrupt context, and they should return as quickly as possible.  Taking too much time in these procedures will cause many unpredictable behaviors, including loss of received data.  See the similar warnings for the built-in [`attachInterrupt`](https://www.arduino.cc/en/Reference/AttachInterrupt) for digital pins.

# Differences from current AltSoftSerial

Support for Arduino IDE v1.0 was removed.

New methods were added for the user-defined IRS: `attachInterrupt`/`detachInterrupt` and `attachTxCompleteInterrupt`/`detachTxCompleteInterrupt`.

Methods for compatibilty with other software serial libraries were removed:
```
	  // for drop-in compatibility with NewSoftSerial, rxPin & txPin ignored
	  AltSoftSerial(uint8_t rxPin, uint8_t txPin, bool inverse = false) { }
```

NeoICSerial

NeoICSerial Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

NeoICSerial

NeoICSerial Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README