## NMSettingSerial

NMSettingSerial — Describes connection properties for devices that use serial communications

## Synopsis

    #include <nm-setting-serial.h>

    #define             NM_SETTING_SERIAL_SETTING_NAME
    enum                NMSettingSerialError;
    #define             NM_SETTING_SERIAL_ERROR
    GQuark              nm_setting_serial_error_quark       (void);
    #define             NM_SETTING_SERIAL_BAUD
    #define             NM_SETTING_SERIAL_BITS
    #define             NM_SETTING_SERIAL_PARITY
    #define             NM_SETTING_SERIAL_STOPBITS
    #define             NM_SETTING_SERIAL_SEND_DELAY
                        NMSettingSerial;
                        NMSettingSerialClass;
    NMSetting *         nm_setting_serial_new               (void);
    guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);
    guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);
    char                nm_setting_serial_get_parity        (NMSettingSerial *setting);
    guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
    guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);

## Object Hierarchy

      GEnum
       +----NMSettingSerialError

      GObject
       +----NMSetting
             +----NMSettingSerial

## Properties

      "baud"                     guint                 : Read / Write / Construct
      "bits"                     guint                 : Read / Write / Construct
      "parity"                   gchar                 : Read / Write / Construct
      "send-delay"               guint64               : Read / Write / Construct
      "stopbits"                 guint                 : Read / Write / Construct

## Description

The NMSettingSerial object is a NMSetting subclass that describes properties necessary for connections that may use serial communications, such as mobile broadband or analog telephone connections.

## Details

### NM_SETTING_SERIAL_SETTING_NAME

    #define NM_SETTING_SERIAL_SETTING_NAME "serial"

### enum NMSettingSerialError

    typedef enum {
    	NM_SETTING_SERIAL_ERROR_UNKNOWN = 0,        /*< nick=UnknownError >*/
    	NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY,   /*< nick=InvalidProperty >*/
    	NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY,   /*< nick=MissingProperty >*/
    	NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING /*< nick=MissingPPPSetting >*/
    } NMSettingSerialError;

`NM_SETTING_SERIAL_ERROR_UNKNOWN` | unknown or unclassified error
`NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY` | the property was invalid
`NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY` | the property was missing and is required
`NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING` | one of the properties of the setting requires the connection to contain an NMSettingPPP setting

### NM_SETTING_SERIAL_ERROR

    #define NM_SETTING_SERIAL_ERROR nm_setting_serial_error_quark ()

### nm_setting_serial_error_quark ()

    GQuark              nm_setting_serial_error_quark       (void);

Registers an error quark for NMSettingSerial if necessary.

Returns : | the error quark used for NMSettingSerial errors.

### NM_SETTING_SERIAL_BAUD

    #define NM_SETTING_SERIAL_BAUD "baud"

### NM_SETTING_SERIAL_BITS

    #define NM_SETTING_SERIAL_BITS "bits"

### NM_SETTING_SERIAL_PARITY

    #define NM_SETTING_SERIAL_PARITY "parity"

### NM_SETTING_SERIAL_STOPBITS

    #define NM_SETTING_SERIAL_STOPBITS "stopbits"

### NM_SETTING_SERIAL_SEND_DELAY

    #define NM_SETTING_SERIAL_SEND_DELAY "send-delay"

### NMSettingSerial

    typedef struct _NMSettingSerial NMSettingSerial;

### NMSettingSerialClass

    typedef struct {
    	NMSettingClass parent;

    	/* Padding for future expansion */
    	void (*_reserved1) (void);
    	void (*_reserved2) (void);
    	void (*_reserved3) (void);
    	void (*_reserved4) (void);
    } NMSettingSerialClass;

### nm_setting_serial_new ()

    NMSetting *         nm_setting_serial_new               (void);

Creates a new NMSettingSerial object with default values.

Returns : | the new empty NMSettingSerial object. [transfer full]

### nm_setting_serial_get_baud ()

    guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);

`setting` : | the NMSettingSerial
Returns : | the "baud" property of the setting

### nm_setting_serial_get_bits ()

    guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);

`setting` : | the NMSettingSerial
Returns : | the "bits" property of the setting

### nm_setting_serial_get_parity ()

    char                nm_setting_serial_get_parity        (NMSettingSerial *setting);

`setting` : | the NMSettingSerial
Returns : | the "parity" property of the setting

### nm_setting_serial_get_stopbits ()

    guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);

`setting` : | the NMSettingSerial
Returns : | the "stopbits" property of the setting

### nm_setting_serial_get_send_delay ()

    guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);

`setting` : | the NMSettingSerial
Returns : | the "send-delay" property of the setting

## Property Details

### The `"baud"` property

      "baud"                     guint                 : Read / Write / Construct

Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.

Default value: 57600

### The `"bits"` property

      "bits"                     guint                 : Read / Write / Construct

Byte-width of the serial communication.

Allowed values: [5,8]

Default value: 8

### The `"parity"` property

      "parity"                   gchar                 : Read / Write / Construct

Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.

Allowed values: [69,111]

Default value: 110

### The `"send-delay"` property

      "send-delay"               guint64               : Read / Write / Construct

Time to delay between each byte sent to the modem, in microseconds.

Default value: 0

### The `"stopbits"` property

      "stopbits"                 guint                 : Read / Write / Construct

Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.

Allowed values: [1,2]

Default value: 1