001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030/**
031 *
032 */
033package org.openimaj.hardware.compass;
034
035import jssc.SerialPort;
036
037import org.openimaj.hardware.serial.SerialDataListener;
038import org.openimaj.hardware.serial.SerialDevice;
039
040/**
041 * This class is used to read data from the Ocean Server serial compass.
042 *
043 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
044 *
045 * @created 13 Jul 2011
046 */
047public class CompassSerialReader implements Runnable
048{
049        /** The port name on which the compass is putting its data */
050        private String portName = null;
051
052        private CompassData latestData = null;
053
054        /**
055         * Constructor that takes the serial port name on which the compass is
056         * putting its data.
057         *
058         * @param portName
059         *            The port name.
060         */
061        public CompassSerialReader(String portName)
062        {
063                this.portName = portName;
064        }
065
066        /**
067         * {@inheritDoc}
068         * 
069         * @see java.lang.Runnable#run()
070         */
071        @Override
072        public void run()
073        {
074                try
075                {
076                        final String firstPort = portName;
077                        System.out.println("Opening " + firstPort);
078
079                        // This is the standard Ocean Server compass configuration
080                        final SerialDevice sd = new SerialDevice(firstPort, 19200,
081                                        SerialPort.DATABITS_8, SerialPort.STOPBITS_1,
082                                        SerialPort.PARITY_NONE);
083
084                        sd.addSerialDataListener(new SerialDataListener()
085                        {
086                                @Override
087                                public void dataReceived(String data)
088                                {
089                                        latestData = OS5000_0x01_Parser.parseLine(data.trim());
090                                }
091                        });
092                } catch (final Exception e)
093                {
094                        e.printStackTrace();
095                }
096
097        }
098
099        /**
100         * @return The most recent compass data
101         */
102        public CompassData getCompassData()
103        {
104                return latestData;
105        }
106
107        /**
108         * @param args
109         */
110        public static void main(String[] args)
111        {
112                new CompassSerialReader("/dev/ttyUSB0").run();
113        }
114}