https://github.com/andyli/hxserial

A library for serial port communication in Haxe (C++/Neko target).
https://github.com/andyli/hxserial

haxe serial

Last synced: 3 months ago
JSON representation

A library for serial port communication in Haxe (C++/Neko target).

• Host: GitHub
• URL: https://github.com/andyli/hxserial
• Owner: andyli
• Created: 2010-05-04T18:19:19.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2020-12-06T19:10:21.000Z (about 4 years ago)
• Last Synced: 2024-04-14T22:16:48.230Z (9 months ago)
• Topics: haxe, serial
• Language: C++
• Homepage:
• Size: 523 KB
• Stars: 34
• Watchers: 8
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# hxSerial

[![TravisCI Build Status](https://travis-ci.org/andyli/hxSerial.svg?branch=master)](https://travis-ci.org/andyli/hxSerial)

[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/andyli/hxSerial?branch=master&svg=true)](https://ci.appveyor.com/project/andyli/hxSerial)

**hxSerial** is a library for serial communication in [Haxe](http://haxe.org) (C++/Neko target). It is based on ofSerial in [OpenFrameworks](http://www.openframeworks.cc/).

## Download and Install

The most easy and proper way is from haxelib:

```

haxelib install hxSerial

```

Or you can download/checkout the source from [the github repo](http://github.com/andyli/hxSerial).

## How to use

Create a `Serial` object, given its device name and speed (in bits per second, ie.baud):

```haxe

var serialObj = new hxSerial.Serial("/dev/tty.usbserial-A4001tkb",9600);

```

The device name above is something you will get in Mac. For Windows, it should be something like "COM7". For Linux (e.g. Ubuntu), it should be similar to "/dev/ttyUSB0".

You can check the device names by `trace(hxSerial.Serial.getDeviceList())`.

You can then read/write to the device using the `readByte`/`writeByte` method.

*Note that you must read from the serial after setup. If the serial input is accumulated for too long, it will slow down the whole system.*

### Writing

For writing, `writeByte()` returns `true` if the operation is successful. `writeBytes()` returns the number of bytes it writes.

### Reading

For reading, you first check the number of bytes arrived by calling `available()`. If the amount of bytes you needed is enough, call `readByte()` to get a single byte as `Int` or call `readBytes()` to get multiple bytes as `String`.

## change log

### version 0.1.2

Fixes for haxe 3.1.3 and hxcpp 3.1.39.

### version 0.1.1

Fixed memory leak and added Neko support.

### version 0.1.0

First release. Supports Windows/Mac/Linux.