Update READMEs

Author: emericg

.gitignore

@@ -16,12 +16,14 @@ SmartServoFramework.includes
 
 # QMake temporary project files (gui)
 gui/SmartServoGui.pro.*
+gui/.qmake.stash
 gui/Makefile
 gui/build/*
 
 # Scons temporary project files (examples)
 examples/.scon*
 examples/build/*
 
-# Netbeans project files
+# Others
+stash/*
 nbproject/*

README.md

@@ -2,14 +2,16 @@ SmartServoFramework 0.95
 ========================
 
 [![Build Status](https://travis-ci.org/emericg/SmartServoFramework.svg?branch=master)](https://travis-ci.org/emericg/SmartServoFramework)
+[![Build status](https://ci.appveyor.com/api/projects/status/doqnmp6jrlqjyt22?svg=true)](https://ci.appveyor.com/project/emericg/smartservoframework)
+[![License: LGPL v3](https://img.shields.io/badge/license-LGPL%20v3-green.svg)](http://www.gnu.org/licenses/lgpl-3.0)
 
 ![SERVO](https://raw.githubusercontent.com/emericg/SmartServoFramework/master/gui/resources/img/dynamixel_ax12_diagram.png)
 
 ## Introduction
 
 SmartServoFramework is a C++ multi-platform framework used to drive "smart servo" devices like Dynamixel or HerkuleX actuators. It has been developed at Inria Grenoble research center.
 
-**Linux** (and most Unix systems), **Mac OS X** and **Windows** operating systems are supported. All you need to begin moving stuff around is at least one servo, a serial port adapter and a modern C++ compiler! SmartServoFramework works well on Raspberry Pi or other embedded boards, but will not work on Arduinos nor any other microcontrollers.
+**Linux** (and most Unix systems), **macOS** and **Windows** operating systems are supported. All you need to begin moving stuff around is at least one servo, a serial port adapter and a modern C++ compiler! SmartServoFramework works well on Raspberry Pi or other embedded boards, but will not work on Arduinos nor any other microcontrollers.
 
 > Dynamixel devices from [Robotis](http://www.robotis.com/) and HerkuleX devices from [Dongbu Robot](http://www.dongburobot.com/) are high-performance networked actuators for robots available in wide range of sizes and strengths.  
 > They have adjustable torque, speed, angle limits, and provide various feedback like position, load, voltage and temperature...
@@ -27,7 +29,7 @@ We provide two different APIs:
 
 You can dynamically generate a **full API documentation** from the source code using Doxygen. This will prove very important in order to work efficiently with the framework. The documentation will be accessible through `doc/API_documentation.html`.
 
-If you are running a Mac/Linux system you can easily generate the documentation from a terminal:
+If you are running a macOS/Linux system you can easily generate the documentation from a terminal:
 > $ cd SmartServoFramework/  
 > $ doxygen Doxyfile  
 
@@ -42,16 +44,13 @@ If you have problems with the command line, it's just as easy to generate the do
 You will need a modern C++11 capable compiler:
 * GCC >= 4.6  
 * LLVM >= 3.0  
-* MSVC >= 2012  
+* MSVC >= 2013  
 
 Build system:
 * CMake (**ONLY** needed to build the standalone library)  
 * Scons (**ONLY** needed to build the examples)  
 * Doxygen (**ONLY** needed to generate the documentation)  
 
-Using Linux?
-* liblockdev (used to lock the serial port to a single software instance, which will save you from a lot of potential head scratching errors...)  
-
 ### Building SmartServoFramework library
 
 > $ cd SmartServoFramework/build/  
@@ -81,9 +80,9 @@ This framework can be used with any combination of RS-232 ports, USB to TTL adap
 One more important thing: you need to power your servos with **proper power supply**. Shaky power sources have been known to cause interferences on serial bus, resulting in numerous packet corruptions. Be careful when using batteries and power converters!
 
 First you will need to make sure your software can access your serial port:
-* If you are running Linux, you will need special permissions from the `uucp` and/or `dialout` groups in order to access serial ports. You can add your user account to these groups with this command: `# useradd -G uucp,dialout $USER` (you'll need root credentials for this operation).
-* If you are running Mac OS X, depending on your adapter, you may need to install the [FTDI driver](http://www.robotis.com/xe/download_en/646927), or the [CP210x driver](http://www.silabs.com/products/mcu/pages/usbtouartbridgevcpdrivers.aspx).
-* If you are running Windows, you will need to install the [FTDI driver for the USB2Dynamixel device](http://www.robotis.com/xe/download_en/646927). You may also need other drivers depending on your adapter (like the [USB2AX driver](https://raw.githubusercontent.com/Xevel/usb2ax/master/firmware/lufa_usb2ax/USB2AX.inf), the [CP210x driver](http://www.silabs.com/products/mcu/pages/usbtouartbridgevcpdrivers.aspx), or the official [FTDI driver](http://www.ftdichip.com/Drivers/D2XX.htm)).
+* If you are running Linux, you may need special permissions from the `uucp` and/or `dialout` groups in order to access serial ports. You can add your user account to these groups with this command: `# useradd -G uucp,dialout $USER` (you'll need root credentials for this operation).
+* If you are running macOS, depending on your adapter, you may need to install the [FTDI driver](http://www.robotis.com/xe/download_en/646927), or the [CP210x driver](http://www.silabs.com/products/mcu/pages/usbtouartbridgevcpdrivers.aspx).
+* If you are running Windows, you may need to install the [FTDI driver for the USB2Dynamixel device](http://www.robotis.com/xe/download_en/646927). You may also need other drivers depending on your adapter (like the [USB2AX driver](https://raw.githubusercontent.com/Xevel/usb2ax/master/firmware/lufa_usb2ax/USB2AX.inf), the [CP210x driver](http://www.silabs.com/products/mcu/pages/usbtouartbridgevcpdrivers.aspx), or the official [FTDI driver](http://www.ftdichip.com/Drivers/D2XX.htm)).
 
 #### Communication with Dynamixel devices
 

doc/SerialCommunication.md

@@ -34,7 +34,7 @@ You need a "regular" RS-232 full-duplex serial port with a TTL level converter t
 
 You will need to make sure your software can access your serial port:
 * If you are running Linux, you will need special permissions from the `uucp` and/or `dialout` groups in order to access serial ports. You can add your user account to these groups with this command: `# useradd -G uucp,dialout $USER` (you'll need root credentials for this operation).
-* If you are running Mac OS X, depending on your adapter, you may need to install the [FTDI driver](http://www.robotis.com/xe/download_en/646927), or the [CP210x driver](http://www.silabs.com/products/mcu/pages/usbtouartbridgevcpdrivers.aspx).
+* If you are running macOS, depending on your adapter, you may need to install the [FTDI driver](http://www.robotis.com/xe/download_en/646927), or the [CP210x driver](http://www.silabs.com/products/mcu/pages/usbtouartbridgevcpdrivers.aspx).
 * If you are running Windows, you will need to install the [FTDI driver for the USB2Dynamixel device](http://www.robotis.com/xe/download_en/646927). You may also need other drivers depending on your adapter (like the [USB2AX driver](https://raw.githubusercontent.com/Xevel/usb2ax/master/firmware/lufa_usb2ax/USB2AX.inf), the [CP210x driver](http://www.silabs.com/products/mcu/pages/usbtouartbridgevcpdrivers.aspx), or the official [FTDI driver](http://www.ftdichip.com/Drivers/D2XX.htm)).
 
 ### Serial port locking mechanism
@@ -45,8 +45,9 @@ The framework will handle locking/unlocking the serial port if a locking method
 * Linux: "lockfile" support
 * Linux: "liblockdev" support (default)
 * Linux: "flock()" support
-* Mac OS X: "lockfile" support
-* Mac OS X: "TIOCEXCL ioctl" support (default)
+* macOS: "lockfile" support
+* macOS: "TIOCEXCL ioctl" support (default)
+* Windows: TODO!
 
 ### About latency
 

src/SerialPortMacOS.cpp

@@ -54,6 +54,7 @@
 
 // Device lock support
 #define LOCK_TIOCEXCL
+//#define LOCK_LOCKFILE
 
 ////////////////////////////////////////////////////////////////////////////////
 
@@ -137,7 +138,7 @@ int serialPortsScanner(std::vector <std::string> &availableSerialPorts)
     kern_return_t kernResult = KERN_FAILURE;
     io_iterator_t serialPortIterator = 0;
 
-    TRACE_INFO(SERIAL, "serialPortsScanner() [MacOS variant]\n");
+    TRACE_INFO(SERIAL, "serialPortsScanner() [macOS variant]\n");
 
     // Serial devices are instances of class IOSerialBSDClient. Create a matching dictionary to find those.
     CFMutableDictionaryRef classesToMatch = NULL;