Cefn Hoile / microbit-dal

Attempting to publish a tree

Dependencies:   BLE_API mbed-dev-bin nRF51822

Fork of microbit-dal by Lancaster University

inc/types/MicroBitCoordinateSystem.h@18:ce4dd8fcdf4f, 2016-06-01 (annotated)

Committer:
cefn
Date:
Wed Jun 01 17:43:26 2016 +0000
Revision:
18:ce4dd8fcdf4f
Parent:
1:8aa5cdb4ab67 
Attempting to publish a tree

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jonathan Austin 1:8aa5cdb4ab67 1 /*
Jonathan Austin 1:8aa5cdb4ab67 2 The MIT License (MIT)
Jonathan Austin 1:8aa5cdb4ab67 3
Jonathan Austin 1:8aa5cdb4ab67 4 Copyright (c) 2016 British Broadcasting Corporation.
Jonathan Austin 1:8aa5cdb4ab67 5 This software is provided by Lancaster University by arrangement with the BBC.
Jonathan Austin 1:8aa5cdb4ab67 6
Jonathan Austin 1:8aa5cdb4ab67 7 Permission is hereby granted, free of charge, to any person obtaining a
Jonathan Austin 1:8aa5cdb4ab67 8 copy of this software and associated documentation files (the "Software"),
Jonathan Austin 1:8aa5cdb4ab67 9 to deal in the Software without restriction, including without limitation
Jonathan Austin 1:8aa5cdb4ab67 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
Jonathan Austin 1:8aa5cdb4ab67 11 and/or sell copies of the Software, and to permit persons to whom the
Jonathan Austin 1:8aa5cdb4ab67 12 Software is furnished to do so, subject to the following conditions:
Jonathan Austin 1:8aa5cdb4ab67 13
Jonathan Austin 1:8aa5cdb4ab67 14 The above copyright notice and this permission notice shall be included in
Jonathan Austin 1:8aa5cdb4ab67 15 all copies or substantial portions of the Software.
Jonathan Austin 1:8aa5cdb4ab67 16
Jonathan Austin 1:8aa5cdb4ab67 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Jonathan Austin 1:8aa5cdb4ab67 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Jonathan Austin 1:8aa5cdb4ab67 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
Jonathan Austin 1:8aa5cdb4ab67 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Jonathan Austin 1:8aa5cdb4ab67 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
Jonathan Austin 1:8aa5cdb4ab67 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
Jonathan Austin 1:8aa5cdb4ab67 23 DEALINGS IN THE SOFTWARE.
Jonathan Austin 1:8aa5cdb4ab67 24 */
Jonathan Austin 1:8aa5cdb4ab67 25
Jonathan Austin 1:8aa5cdb4ab67 26 #ifndef MICROBIT_COORDINATE_SYSTEM_H
Jonathan Austin 1:8aa5cdb4ab67 27 #define MICROBIT_COORDINATE_SYSTEM_H
Jonathan Austin 1:8aa5cdb4ab67 28 #include "MicroBitConfig.h"
Jonathan Austin 1:8aa5cdb4ab67 29
Jonathan Austin 1:8aa5cdb4ab67 30 /**
Jonathan Austin 1:8aa5cdb4ab67 31 * Co-ordinate systems that can be used.
Jonathan Austin 1:8aa5cdb4ab67 32 * RAW: Unaltered data. Data will be returned directly from the accelerometer.
Jonathan Austin 1:8aa5cdb4ab67 33 *
Jonathan Austin 1:8aa5cdb4ab67 34 * SIMPLE_CARTESIAN: Data will be returned based on an easy to understand alignment, consistent with the cartesian system taught in schools.
Jonathan Austin 1:8aa5cdb4ab67 35 * When held upright, facing the user:
Jonathan Austin 1:8aa5cdb4ab67 36 *
Jonathan Austin 1:8aa5cdb4ab67 37 * /
Jonathan Austin 1:8aa5cdb4ab67 38 * +--------------------+ z
Jonathan Austin 1:8aa5cdb4ab67 39 * | |
Jonathan Austin 1:8aa5cdb4ab67 40 * | ..... |
Jonathan Austin 1:8aa5cdb4ab67 41 * | * ..... * |
Jonathan Austin 1:8aa5cdb4ab67 42 * ^ | ..... |
Jonathan Austin 1:8aa5cdb4ab67 43 * | | |
Jonathan Austin 1:8aa5cdb4ab67 44 * y +--------------------+ x-->
Jonathan Austin 1:8aa5cdb4ab67 45 *
Jonathan Austin 1:8aa5cdb4ab67 46 *
Jonathan Austin 1:8aa5cdb4ab67 47 * NORTH_EAST_DOWN: Data will be returned based on the industry convention of the North East Down (NED) system.
Jonathan Austin 1:8aa5cdb4ab67 48 * When held upright, facing the user:
Jonathan Austin 1:8aa5cdb4ab67 49 *
Jonathan Austin 1:8aa5cdb4ab67 50 * z
Jonathan Austin 1:8aa5cdb4ab67 51 * +--------------------+ /
Jonathan Austin 1:8aa5cdb4ab67 52 * | |
Jonathan Austin 1:8aa5cdb4ab67 53 * | ..... |
Jonathan Austin 1:8aa5cdb4ab67 54 * | * ..... * |
Jonathan Austin 1:8aa5cdb4ab67 55 * ^ | ..... |
Jonathan Austin 1:8aa5cdb4ab67 56 * | | |
Jonathan Austin 1:8aa5cdb4ab67 57 * x +--------------------+ y-->
Jonathan Austin 1:8aa5cdb4ab67 58 *
Jonathan Austin 1:8aa5cdb4ab67 59 */
Jonathan Austin 1:8aa5cdb4ab67 60 enum MicroBitCoordinateSystem
Jonathan Austin 1:8aa5cdb4ab67 61 {
Jonathan Austin 1:8aa5cdb4ab67 62 RAW,
Jonathan Austin 1:8aa5cdb4ab67 63 SIMPLE_CARTESIAN,
Jonathan Austin 1:8aa5cdb4ab67 64 NORTH_EAST_DOWN
Jonathan Austin 1:8aa5cdb4ab67 65 };
Jonathan Austin 1:8aa5cdb4ab67 66
Jonathan Austin 1:8aa5cdb4ab67 67 #endif