SerialInterface (Javasnice 0.2.1 API)

java.lang.Object
- org.javascool.proglets.commSerie.SerialInterface

```
public class SerialInterface
extends Object
```
Adaptation for Javasnice of the PSerial - class for serial port goodness Part of the Processing project - http://processing.org Copyright (c) 2004-05 Ben Fry & Casey Reas Définit les primitives pour s'interfacer avec un port série.
Les erreurs d'entrée-sortie sont affichée dans la console (System.out).

See Also:

code source

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SerialInterface.Reader` Définit un lecteur de caractère.
`static interface`	`SerialInterface.Writer` Définit un moniteur des caractères émis.

Constructor Summary

Constructors
Constructor and Description

SerialInterface()

Constructors
Constructor and Description
`SerialInterface()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Ferme le port série.
`String`	`getName()` Renvoie le nom du port série.
`int`	`getParity()` Renvoie la parité du port série.
`static String[]`	`getPortNames()` Renvoie la liste des noms de ports séries disponibles.
`int`	`getRate()` Renvoie le débit du port série.
`int`	`getSize()` Renvoie la taille des mots du port série.
`double`	`getStop()` Renvoie le nombre de bits de stop du port série.
`static boolean`	`isASCII(String value)` Teste si une chaîne ne contient que des caractères l'ASCII.
`boolean`	`isOpen()` Teste si le port est ouvert.
`static void`	`main(String[] usage)` Renvoie la liste des des noms de ports séries disponibles ce qui teste l'installation des librairies.
`SerialInterface`	`open()` Ouvre le port série avec les paramètres actuels.
`int`	`read()` Lit un octet sur le port série.
`SerialInterface`	`setName(String name)` Définit le nom du port série.
`SerialInterface`	`setParity(char parity)` Définit la parité du port série.
`SerialInterface`	`setRate(int rate)` Définit le débit du port série.
`SerialInterface`	`setReader(SerialInterface.Reader reader)` Connecte un reader au port série.
`SerialInterface`	`setSize(int size)` Définit la taille des mots du port série.
`SerialInterface`	`setStop(double stop)` Définit le nombre de bits de stop du port série.
`SerialInterface`	`setWriter(SerialInterface.Writer writer)` Connecte un writer au port série.
`static void`	`show(com.fazecast.jSerialComm.SerialPort id)`
`void`	`simulReading(String string)` Ajoute des octets entrée pour simuler une lecture.
`String`	`toString()` Renvoie une description des paramètres du port série.
`void`	`write(int value)` Ecrit un octet sur le port série.
`boolean`	`write(String value)` Ecrit les octets d'une chaîne de caractère sur le port série.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SerialInterface
```
public SerialInterface()
```
- Method Detail
  - setName
```
public SerialInterface setName(String name)
```
    Définit le nom du port série.
    
    Parameters:
    
    name - Le nom du port, "COM1" par défaut.
    
    Returns:
    
    Cet objet permettant la construction new SerialInterface().setName(...
  - getName
```
public String getName()
```
    Renvoie le nom du port série.
  - setRate
```
public SerialInterface setRate(int rate)
```
    Définit le débit du port série.
    
    Parameters:
    
    rate - Le débit du port en bauds (bits par seconde), 9600 par défaut.
    
    Returns:
    
    Cet objet permettant la construction new SerialInterface().setRate(...
  - getRate
```
public int getRate()
```
    Renvoie le débit du port série.
  - setParity
```
public SerialInterface setParity(char parity)
```
    Définit la parité du port série.
    
    Parameters:
    
    parity - La parité du port : 'N' (par défaut) si pas de parité, 'E' pour even si parité paire, 'O' pour odd si parité impaire.
    
    Returns:
    
    Cet objet permettant la construction new SerialInterface().setParity(...
  - getParity
```
public int getParity()
```
    Renvoie la parité du port série.
  - setSize
```
public SerialInterface setSize(int size)
```
    Définit la taille des mots du port série.
    
    Parameters:
    
    size - La taille des mots : 8 (par défaut) ou 7..
    
    Returns:
    
    Cet objet permettant la construction new SerialInterface().setSize(...
  - getSize
```
public int getSize()
```
    Renvoie la taille des mots du port série.
  - setStop
```
public SerialInterface setStop(double stop)
```
    Définit le nombre de bits de stop du port série.
    
    Parameters:
    
    stop - Le nombre de bits de stop : 1 (par défaut), 1.5 ou 2.
    
    Returns:
    
    Cet objet permettant la construction new SerialInterface().setStop(...
  - getStop
```
public double getStop()
```
    Renvoie le nombre de bits de stop du port série.
  - open
```
public SerialInterface open()
```
    Ouvre le port série avec les paramètres actuels.
    
    Returns:
    
    Cet objet permettant la construction new SerialInterface().set*(.. ). open().
  - close
```
public void close()
```
    Ferme le port série.
  - isOpen
```
public boolean isOpen()
```
    Teste si le port est ouvert.
    
    Returns:
    
    Renvoie true si le port a été ouvert sans erreur.
  - write
```
public void write(int value)
```
    Ecrit un octet sur le port série.
    
    Parameters:
    
    value - L'octet à écrire.
  - write
```
public boolean write(String value)
```
    Ecrit les octets d'une chaîne de caractère sur le port série.
    
    Parameters:
    
    value - Les octets à écrire. La chaîne ne doit contenir que des caractères ASCII.
    
    Returns:
    
    La valeur true, si la chaîne est bien de l'ASCII, et fausse sinon. Dans ce cas aucun caratère n'est écrit.
  - isASCII
```
public static boolean isASCII(String value)
```
    Teste si une chaîne ne contient que des caractères l'ASCII.
    
    Parameters:
    
    value - La chaîne à tester.
    
    Returns:
    
    La valeur true, si la chaîne est bien de l'ASCII, et fausse sinon.
  - setWriter
```
public SerialInterface setWriter(SerialInterface.Writer writer)
```
    Connecte un writer au port série.
    
    Parameters:
    
    writer - Un writer qui est appellé à chaque caratère écrit.
    
    Returns:
    
    Cet objet permettant la construction new SerialInterface().setWriter(...
  - read
```
public int read()
```
    Lit un octet sur le port série.
    L'octet lu est retiré du buffer de lecture, après l'appel de cette fonction.
    
    Returns:
    
    La valeur de l'octet à lire ou -1 si il n'y a pas d'octet à lire.
  - setReader
```
public SerialInterface setReader(SerialInterface.Reader reader)
```
    Connecte un reader au port série.
    
    Parameters:
    
    reader - Un reader qui est appellé à l'arrivée de chaque caractère en lecture.
    
    Returns:
    
    Cet objet permettant la construction new SerialInterface().setReader(...
  - simulReading
```
public void simulReading(String string)
```
    Ajoute des octets entrée pour simuler une lecture.
    
    Parameters:
    
    string - Les octets en entrée.
  - toString
```
public String toString()
```
    Renvoie une description des paramètres du port série.
    
    Overrides:
    
    toString in class Object
  - getPortNames
```
public static String[] getPortNames()
```
    Renvoie la liste des noms de ports séries disponibles.
  - show
```
public static void show(com.fazecast.jSerialComm.SerialPort id)
```
  - main
```
public static void main(String[] usage)
```
    Renvoie la liste des des noms de ports séries disponibles ce qui teste l'installation des librairies.
    
    Parameters:
    
    usage - java -cp javascool-proglets.jar org.javascool.proglets.commSerie.SerialInterface

Class SerialInterface

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SerialInterface

Method Detail

setName

getName

setRate

getRate

setParity

getParity

setSize

getSize

setStop

getStop

open

close

isOpen

write

write

isASCII

setWriter

read

setReader

simulReading

toString

getPortNames

show

main