ST Expansion SW Team / LSM303AGR_JS

Javascript wrappers for LSM303AGR Sensor library

Dependencies:   LSM303AGR

Dependents:   ST_SENSOR_JS

LSM303AGR_JS.h@4:ae1fba759405, 2018-01-17 (annotated)

Committer:
akhtar.syedzeeshan@gmail.com
Date:
Wed Jan 17 10:56:45 2018 +0100
Revision:
4:ae1fba759405
Parent:
3:d076984ee23b 
Code fixes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 1 /**
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 2 ******************************************************************************
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 3 * @file LSM303AGR_JS.h
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 4 * @author ST
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 5 * @version V1.0.0
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 6 * @date 9 October 2017
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 7 * @brief Implementation of an LSM303AGR Accelerometer and Magnetometer sensor for
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 8 * use with Javascript.
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 9 ******************************************************************************
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 10 * @attention
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 11 *
akhtar.syedzeeshan@gmail.com 4:ae1fba759405 12 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 13 *
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 14 * Redistribution and use in source and binary forms, with or without modification,
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 15 * are permitted provided that the following conditions are met:
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 16 * 1. Redistributions of source code must retain the above copyright notice,
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 17 * this list of conditions and the following disclaimer.
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 19 * this list of conditions and the following disclaimer in the documentation
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 20 * and/or other materials provided with the distribution.
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 22 * may be used to endorse or promote products derived from this software
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 23 * without specific prior written permission.
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 24 *
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 35 *
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 36 ******************************************************************************
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 37 */
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 38
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 39
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 40 /* Prevent recursive inclusion -----------------------------------------------*/
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 41
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 42 #ifndef __LSM303AGR_JS_H__
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 43 #define __LSM303AGR_JS_H__
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 44
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 45 /* Includes ------------------------------------------------------------------*/
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 46
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 47 #include <stdint.h>
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 48 #include "mbed.h"
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 49 #include "LSM303AGRMagSensor.h"
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 50 #include "LSM303AGRAccSensor.h"
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 51
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 52 /* Class Declaration ---------------------------------------------------------*/
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 53
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 54 /**
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 55 * Abstract class of an LSM303AGR Humidity and Temperature sensor for Javascript.
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 56 */
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 57 class LSM303AGR_JS {
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 58 private:
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 59 /* Helper classes. */
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 60 LSM303AGRMagSensor *magnetometer = NULL;
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 61 LSM303AGRAccSensor *accelerometer = NULL;
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 62
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 63 public:
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 64 /* Constructors */
akhtar.syedzeeshan@gmail.com 4:ae1fba759405 65 LSM303AGR_JS(){}
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 66
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 67 //LSM303AGRAccSensor(SPI *spi, PinName cs_pin, PinName int1_pin=NC, PinName int2_pin=NC); // SPI3W ONLY
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 68 void init_acc(SPI &spi, PinName cs_pin);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 69 void init_acc(SPI &spi, PinName cs_pin, PinName int1_pin, PinName int2_pin);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 70
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 71 //LSM303AGRAccSensor(DevI2C *i2c, uint8_t address=LSM303AGR_ACC_I2C_ADDRESS, PinName int1_pin=NC, PinName int2_pin=NC);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 72 void init_acc(DevI2C &devI2c);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 73 void init_acc(DevI2C &devI2c, PinName int1_pin, PinName int2_pin);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 74 void init_acc(DevI2C &devI2c, PinName int1_pin, PinName int2_pin, uint8_t address);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 75
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 76 //LSM303AGRMagSensor(SPI *spi, PinName cs_pin, PinName intmag_pin=NC); // SPI3W ONLY
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 77 void init_mag(SPI &spi, PinName cs_pin);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 78 void init_mag(SPI &spi, PinName cs_pin, PinName int_pin);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 79
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 80 //LSM303AGRMagSensor(DevI2C *i2c, uint8_t address=LSM303AGR_MAG_I2C_ADDRESS, PinName int_pin=NC);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 81 void init_mag(DevI2C &devI2c);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 82 void init_mag(DevI2C &devI2c, PinName int_pin);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 83 void init_mag(DevI2C &devI2c, PinName int_pin, uint8_t address);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 84
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 85
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 86 /* Destructor */
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 87 ~LSM303AGR_JS();
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 88
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 89 /* Declarations */
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 90 char *make_json(char* str, int32_t *data, char *axes, int data_count);
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 91 uint8_t read_magnetometer_id();
akhtar.syedzeeshan@gmail.com 3:d076984ee23b 92 uint8_t read_accelerometer_id();
akhtar.syedzeeshan@gmail.com 2:ddbdfca82832 93 int32_t *get_accelerometer_axes(int32_t *);
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 94 char *get_accelerometer_axes_json(char *);
akhtar.syedzeeshan@gmail.com 2:ddbdfca82832 95 int32_t *get_magnetometer_axes(int32_t *);
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 96 char *get_magnetometer_axes_json(char *);
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 97
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 98 };
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 99
akhtar.syedzeeshan@gmail.com 0:23a17bd32990 100 #endif