Flutter Libserialport

https://pub.dev/documentation/flutter_libserialport/latest
Admin
Flutter Libserialport is a Dart wrapper for the libserialport C-library, simplifying serial port...
Tokens:42,337
Snippets:157
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Add flutter_libserialport to pubspec.yaml

Source: https://pub.dev/documentation/flutter_libserialport/latest/index

This snippet shows how to add the flutter_libserialport package as a dependency in your Flutter project's pubspec.yaml file to start using serial port functionalities.

```YAML
dependencies:
  flutter_libserialport: ^0.6.0
```

--------------------------------

### Getting Available Serial Ports

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort-class

Shows how to retrieve a list of all serial ports currently available on the system using the 'availablePorts' static property.

```Dart
availablePorts → List<String>
```

--------------------------------

### Get Available Serial Ports (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/availablePorts

Retrieves a list of all serial ports available on the system. This property is part of the `SerialPort` class and relies on the `_SerialPortImpl` for its implementation.

```Dart
static List<String> get availablePorts => _SerialPortImpl.availablePorts;
```

--------------------------------

### Get/Set XON/XOFF Configuration

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Gets or sets the XON/XOFF flow control configuration for the serial port. A value of -1 leaves the setting unchanged.

```Dart
int get xonXoff => _xonXoff;
set xonXoff(int value) {
  _xonXoff = value;
}
```

--------------------------------

### Get SerialPort Configuration

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/config

Retrieves the current configuration settings of the serial port. This getter allows you to inspect the active parameters of the serial port.

```dart
SerialPortConfig get config;
```

--------------------------------

### Get/Set DSR Pin Behaviour

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Gets or sets the Data Set Ready (DSR) pin behaviour for the serial port configuration. A value of -1 leaves the setting unchanged.

```Dart
int get dsr => _dsr;
set dsr(int value) {
  _dsr = value;
}
```

--------------------------------

### Get RTS Property - flutter_libserialport

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/rts

Retrieves the RTS pin behavior from the serial port configuration. This property is part of the `SerialPortConfig` class and is used to manage hardware flow control settings.

```Dart
int get rts;
```

--------------------------------

### Get DTR Property - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/dtr

Retrieves the current Data Terminal Ready (DTR) pin behavior from the serial port configuration. This is part of the SerialPortConfig class in the flutter_libserialport library.

```Dart
int get dtr;
```

--------------------------------

### Get USB Product Name - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/productName

The `productName` property in the `SerialPort` class allows you to retrieve the USB product name of a USB serial adapter port. This is a getter that returns a nullable String.

```Dart
String? get productName;
```

--------------------------------

### Get Serial Port Name (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/name

Retrieves the name of the serial port. The returned name is the standard identifier used by the operating system, like 'COMn' for Windows or a device path for Unix.

```Dart
String? get name;
```

--------------------------------

### Get SerialPort Transport Type (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/transport

This code snippet demonstrates how to get the transport type of a serial port using the flutter_libserialport package. The 'transport' property returns an integer representing the transport type.

```Dart
int get transport;

```

--------------------------------

### Get baudRate - SerialPortConfig

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/baudRate

Retrieves the current baud rate setting for a serial port configuration. This is a read-only property.

```Dart
int get baudRate;
```

--------------------------------

### SerialPortRts Constructor - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortRts/SerialPortRts

Demonstrates the basic instantiation of the SerialPortRts class using its default constructor.

```Dart
SerialPortRts()
```

--------------------------------

### Create SerialPortDsr Instance

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortDsr/SerialPortDsr

Demonstrates how to create a new instance of the SerialPortDsr class. This is the primary way to initialize a SerialPortDsr object.

```dart
SerialPortDsr()
```

--------------------------------

### Get/Set Parity

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Gets or sets the parity setting for the serial port configuration. A value of -1 leaves the setting unchanged.

```Dart
int get parity => _parity;
set parity(int value) {
  _parity = value;
}
```

--------------------------------

### Get bytesToWrite Property (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/bytesToWrite

Retrieves the number of bytes that are currently waiting to be written to the serial port. This is a read-only property.

```Dart
int get bytesToWrite;

```

--------------------------------

### SerialPort description property getter

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/description

Retrieves the description of a serial port for end-user presentation. This is a nullable String property.

```Dart
String? get description;
```

--------------------------------

### Create SerialPortConfig

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/SerialPortConfig

Creates a new serial port configuration object using the default implementation. Remember to call the dispose() method on the returned object to free up resources when you are finished with the serial port configuration.

```Dart
factory SerialPortConfig() => _SerialPortConfigImpl();
```

--------------------------------

### Get/Set Baud Rate

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Gets or sets the baud rate for the serial port configuration. A value of -1 leaves the setting unchanged.

```Dart
int get baudRate => _baudRate;
set baudRate(int value) {
  _baudRate = value;
}
```

--------------------------------

### Open Serial Port (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/open

The `open` abstract method is used to open a serial port. It requires an integer `mode` parameter to specify the opening mode. This method is part of the SerialPort class in the flutter_libserialport library.

```Dart
bool open({
  required int mode,
});
```

--------------------------------

### Get/Set Stop Bits

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Gets or sets the number of stop bits for the serial port configuration. A value of -1 leaves the setting unchanged.

```Dart
int get stopBits => _stopBits;
set stopBits(int value) {
  _stopBits = value;
}
```

--------------------------------

### Create SerialPort Instance (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/SerialPort

This snippet shows how to create a new serial port instance using the `SerialPort.new` factory constructor. It takes the serial port's name as a string argument. Remember to call `dispose()` on the created instance when finished to free up system resources.

```Dart
factory SerialPort(String name) => _SerialPortImpl(name);
```

--------------------------------

### SerialPortDtr Constructor

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortDtr/SerialPortDtr

This snippet shows the basic constructor for the SerialPortDtr class in Dart. It is used to initialize a new instance of the SerialPortDtr.

```Dart
SerialPortDtr()
```

--------------------------------

### Get/Set Data Bits

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Gets or sets the number of data bits for the serial port configuration. A value of -1 leaves the setting unchanged.

```Dart
int get bits => _bits;
set bits(int value) {
  _bits = value;
}
```

--------------------------------

### SerialPortSignal Constructor - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortSignal/SerialPortSignal

The default constructor for the SerialPortSignal class in the flutter_libserialport package. It initializes a new instance of SerialPortSignal.

```Dart
SerialPortSignal()
```

--------------------------------

### SerialPortParity Constructor - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortParity/SerialPortParity

This snippet shows the basic constructor for the SerialPortParity class in Dart. It is used to create instances of SerialPortParity, which represents parity settings for serial communication.

```Dart
SerialPortParity()

```

--------------------------------

### Get stopBits Property

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/stopBits

Retrieves the current stop bits setting for a serial port configuration. This property is part of the SerialPortConfig class in the flutter_libserialport library.

```Dart
int get stopBits;
```

--------------------------------

### Get Parity Setting - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/parity

Retrieves the current parity setting from the serial port configuration. This property is part of the SerialPortConfig class in the flutter_libserialport library.

```Dart
int get parity;
```

--------------------------------

### SerialPortDsr Class Overview

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortDsr-class

Provides an overview of the SerialPortDsr class, its purpose in managing DSR pin behavior, and its constants for flow control and ignoring DSR.

```Dart
class SerialPortDsr {
  // DSR pin behaviour.

  // Constructors 
  SerialPortDsr.new();

  // Properties 
  // hashCode → int
  // runtimeType → Type

  // Methods 
  // noSuchMethod(Invocation invocation) → dynamic
  // toString() → String

  // Operators 
  // operator ==(Object other) → bool

  // Constants 
  static const int flowControl = 0; // DSR used for flow control.
  static const int ignore = 1; // DSR ignored.
  static const int invalid = -1; // Special value to indicate setting should be left alone.
}
```

--------------------------------

### Opening a Serial Port

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort-class

Shows how to open a serial port with a specified mode. The 'open' method takes a 'mode' parameter to define the type of access (e.g., read, write, read-write).

```Dart
open({required int mode}) → bool
```

--------------------------------

### Get xonXoff Property (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/xonXoff

Retrieves the XON/XOFF flow control configuration from the serial port's configuration. This is part of the SerialPortConfig class in the flutter_libserialport package.

```Dart
int get xonXoff;
```

--------------------------------

### SerialPort startBreak Method (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/startBreak

The `startBreak` method is an abstract method within the `SerialPort` class. It is responsible for setting the transmit line of the serial port into a break state. This is a common operation for serial communication control.

```Dart
bool startBreak();
```

--------------------------------

### Get DSR Property - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/dsr

Retrieves the DSR pin behavior from the serial port configuration. This property is part of the SerialPortConfig class and is related to the SerialPortDsr enum.

```dart
int get dsr;
```

--------------------------------

### Create SerialPortConfig from Address

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Creates a serial port configuration from a given memory address. This is an internal constructor.

```Dart
factory SerialPortConfig.fromAddress(int address) {
  // Implementation details omitted for brevity
  return SerialPortConfig();
}
```

--------------------------------

### Get SerialPortConfig Data Bits (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/bits

Retrieves the current data bit configuration for a serial port. This is a getter property within the SerialPortConfig class.

```Dart
int get bits;
```

--------------------------------

### Open Serial Port for Reading (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/openRead

The `openRead` method is an abstract method within the `SerialPort` class. It is designed to open the serial port, enabling read-only operations. This method is part of the `flutter_libserialport` package, commonly used for serial communication in Flutter applications.

```Dart
bool openRead();
```

--------------------------------

### Get SerialPort Signals Status (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/signals

Retrieves the status of the control signals for the serial port. This is a getter property that returns an integer representing the signal status.

```dart
int get signals;
```

--------------------------------

### Open Serial Port for Writing (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/openWrite

The `openWrite` method is an abstract method within the `SerialPort` class. It is designed to open the serial port, enabling only write operations. This method is part of the `flutter_libserialport` package.

```Dart
bool openWrite();
```

--------------------------------

### SerialPortCts Constructor - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortCts/SerialPortCts

This is the default constructor for the SerialPortCts class in the flutter_libserialport package. It initializes a new instance of SerialPortCts.

```Dart
SerialPortCts()
```

--------------------------------

### Get/Set RTS Pin Behaviour

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Gets or sets the Request To Send (RTS) pin behaviour for the serial port configuration. A value of -1 leaves the setting unchanged.

```Dart
int get rts => _rts;
set rts(int value) {
  _rts = value;
}
```

--------------------------------

### SerialPortXonXoff Constructor (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortXonXoff/SerialPortXonXoff

This snippet shows the default constructor for the SerialPortXonXoff class in Dart. It is used to create a new instance of the SerialPortXonXoff object, typically for managing serial port communication with XON/XOFF flow control.

```Dart
SerialPortXonXoff()
```

--------------------------------

### Get/Set CTS Pin Behaviour

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Gets or sets the Clear To Send (CTS) pin behaviour for the serial port configuration. A value of -1 leaves the setting unchanged.

```Dart
int get cts => _cts;
set cts(int value) {
  _cts = value;
}
```

--------------------------------

### Get Serial Port Address (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig/address

This snippet shows the Dart implementation for the 'address' property of the SerialPortConfig class. It is an integer getter that returns the address of the serial port.

```Dart
int get address;

```

--------------------------------

### rxReady Constant Implementation

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortEvent/rxReady-constant

This snippet shows the implementation of the rxReady constant in Dart. It is defined as a static integer constant with the value 1, used to indicate that data is ready to be read from a serial port.

```dart
static const int rxReady = 1;
```

--------------------------------

### Get SerialPort vendorId

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/vendorId

Retrieves the USB vendor ID of a USB serial adapter port. This property is of type int? and is part of the SerialPort class in the flutter_libserialport library.

```Dart
int? get vendorId;
```

--------------------------------

### Get SerialPort Manufacturer (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/manufacturer

Retrieves the USB manufacturer of a USB serial adapter port using the 'manufacturer' property of the SerialPort class. This is part of the flutter_libserialport package.

```Dart
String? get manufacturer;
```

--------------------------------

### SerialPortReader Constructor - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortReader-class

Creates a SerialPortReader for a given SerialPort. An optional timeout can be specified for read attempts after a failure to open the port, defaulting to 500ms.

```Dart
SerialPortReader.new(SerialPort port, {int? timeout})
```

--------------------------------

### Get deviceNumber Property (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/deviceNumber

Retrieves the USB device number for a serial port. This property is part of the SerialPort class and returns an integer representing the device number.

```Dart
int? get deviceNumber;
```

--------------------------------

### Create SerialPortConfig

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Creates a new serial port configuration object. All settings are initialized to -1, indicating they should be left unchanged.

```Dart
factory SerialPortConfig.new() {
  // Implementation details omitted for brevity
  return SerialPortConfig();
}
```

--------------------------------

### Open Serial Port for Read/Write in Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/openReadWrite

The `openReadWrite` abstract method is part of the `SerialPort` class in the `flutter_libserialport` package. It is responsible for opening the serial port, enabling both reading and writing capabilities. This is a fundamental operation for serial communication.

```Dart
bool openReadWrite();
```

--------------------------------

### Get/Set DTR Pin Behaviour

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortConfig-class

Gets or sets the Data Terminal Ready (DTR) pin behaviour for the serial port configuration. A value of -1 leaves the setting unchanged.

```Dart
int get dtr => _dtr;
set dtr(int value) {
  _dtr = value;
}
```

--------------------------------

### Define Input Constant (Dart)

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortBuffer/input-constant

This snippet shows the definition of the 'input' constant, an integer value representing input buffering, within the context of the flutter_libserialport package.

```Dart
static const int input = 1;
```

--------------------------------

### Dart - SerialPort isOpen Property

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPort/isOpen

The 'isOpen' property in the SerialPort class is a boolean getter that indicates the current status of the serial port. It returns true if the port has been successfully opened and is ready for communication, and false if it is closed or in an error state. This property is crucial for checking the port's availability before attempting read or write operations.

```Dart
bool get isOpen;
```

--------------------------------

### SerialPortEvent Constructor - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortEvent/SerialPortEvent

This snippet shows the default constructor for the SerialPortEvent class in Dart. It is used to create new instances of SerialPortEvent.

```Dart
SerialPortEvent()
```

--------------------------------

### Dart: SerialPortXonXoff Output Constant

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortXonXoff/output-constant

Defines the 'output' constant for the SerialPortXonXoff class. This constant is used to enable XON/XOFF flow control specifically for output streams. It is part of the flutter_libserialport library.

```Dart
static const int output = 2;
```

--------------------------------

### SerialPortFlowControl Constructor - Dart

Source: https://pub.dev/documentation/flutter_libserialport/latest/flutter_libserialport/SerialPortFlowControl/SerialPortFlowControl

This snippet shows the default constructor for the SerialPortFlowControl class. It is used to initialize a new instance of SerialPortFlowControl, which is part of the flutter_libserialport package for managing serial communication settings in Flutter applications.

```dart
SerialPortFlowControl()
```
Tokens:
Raw