src/hmc5883l/hmc5883l.h

   1 /*
   2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 #pragma once
  25
  26 #include <mraa/i2c.h>
  27
  28 #define MAX_BUFFER_LENGTH 6
  29
  30 namespace upm {
  31
  32 /**
  33  * @brief C++ API for HMC5883l (3-axis digital compass)
  34  *
  35  * This file defines the HMC5883l C++ interface for libhmc5883l
  36  *
  37  * @snippet hmc5883l.cxx Interesting
  38  *
  39  */
  40
  41 class Hmc5883l {
  42 public:
  43     /**
  44      * Creates a Hmc5883l object
  45      *
  46      * @param bus number of used i2c bus
  47      *
  48      */
  49     Hmc5883l(int bus);
  50
  51     /*
  52      * Returns the direction
  53      */
  54     float direction();
  55
  56     /*
  57      * Returns the heading
  58      */
  59     float heading();
  60
  61     /**
  62      * Returns a pointer to an int[3] that contains the coordinates as ints
  63      *
  64      * @return *int to an int[3]
  65      */
  66     int* coordinates();
  67
  68     /**
  69      * Updates the values by reading from i2c
  70      *
  71      * @return 0 for success
  72      */
  73     int update();
  74 private:
  75     int m_coor[3];
  76     uint8_t m_rx_tx_buf[MAX_BUFFER_LENGTH];
  77     mraa_i2c_context m_i2c;
  78 };
  79
  80 }