Skip to content
README.md 1.85 KiB
Newer Older
getSurreal's avatar
getSurreal committed
XV Lidar Controller
===================

getSurreal's avatar
getSurreal committed
Control the Neato XV Lidar with an Arduino compatible board
getSurreal's avatar
getSurreal committed

getSurreal's avatar
getSurreal committed
Used as an interface board to connect directly to the Neato XV Lidar and control the rotation speed through Pulse Width Modulation (PWM).

getSurreal's avatar
getSurreal committed
v1.1.1 Copyright 2014 James LeRoy getSurreal.com
James LeRoy's avatar
James LeRoy committed
* http://www.getsurreal.com/products/xv-lidar-controller
getSurreal's avatar
getSurreal committed
* https://github.com/getSurreal/XV_Lidar_Controller
getSurreal's avatar
getSurreal committed

getSurreal's avatar
getSurreal committed
Based on the following work: 
getSurreal's avatar
getSurreal committed
* Nicolas "Xevel" Saugnier https://github.com/bombilee/NXV11/
* Cheng-Lung Lee https://github.com/bombilee/NXV11/tree/master/ArduinoMegaAdapter
getSurreal's avatar
getSurreal committed

getSurreal's avatar
getSurreal committed

##Description
The XV Lidar Controller receives the serial data from the XV Lidar looking for the RPM data embedded in the stream and uses a PID controller to regulate the speed to 300RPMs.  The data received from the Lidar is relayed to the USB connection for some upstream host device (PC, BeagleBone, Raspberry Pi) to process the data.

getSurreal's avatar
getSurreal committed
##Requirements
getSurreal's avatar
getSurreal committed

getSurreal's avatar
getSurreal committed
###Hardware
* Neato XV Lidar - Available on eBay
* Teensy 2.0 http://www.pjrc.com/teensy
getSurreal's avatar
getSurreal committed
* XV Lidar Controller Board by getSurreal http://www.getsurreal.com/xv-lidar-controller
getSurreal's avatar
getSurreal committed
* Firmware https://github.com/getSurreal/XV_Lidar_Controller


###Software to build from source
getSurreal's avatar
getSurreal committed
* Arduino IDE (v1.0.5 tested. Newer or older may work)
* Teensyduino - Software add-on to run Arduino sketches on the Teensy (v1.19 tested. Newer or older may work)
getSurreal's avatar
getSurreal committed
 http://www.pjrc.com/teensy/teensyduino.html
* Copy the included libraries to the Arduino libraries directory
getSurreal's avatar
getSurreal committed

getSurreal's avatar
getSurreal committed
##Usage
Connect to the Teensy USB port at 115200 baud.  When sending commands use newline to signify the end of a command.  Before sending most commands it's helpful to stop the streaming of serial data with RelayOff.
getSurreal's avatar
getSurreal committed

##Commands
getSurreal's avatar
getSurreal committed
Commands are case sensitive.
getSurreal's avatar
getSurreal committed
* Help
* GetConfig
* SaveConfig
* ResetConfig
* MotorOff
* MotorOn
* RelayOff
* RelayOn
* SetRPM
* SetKp
* SetKi
* SetKd
getSurreal's avatar
getSurreal committed
* SetSampleTime
getSurreal's avatar
getSurreal committed
* ShowRPM
* HideRPM