registers.h File Reference

Provides the Registers class, which initializes with a suite of accessors suitable for reading and writing the UM7 registers, including byte-order conversion and scaling handled. More...

#include <endian.h>
#include <math.h>
#include <stdint.h>
#include <string.h>
#include <string>
#include <stdexcept>
#include "um7/firmware_registers.h"

Include dependency graph for registers.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	um7::Accessor< RegT >
class	um7::Accessor_
class	um7::Registers
Namespaces
namespace	um7
Defines
#define	NUM_REGISTERS   (DATA_REG_START_ADDRESS + DATA_ARRAY_SIZE)
#define	TO_DEGREES   (180.0 / M_PI)
#define	TO_RADIANS   (M_PI / 180.0)
Functions
void	um7::memcpy_network (void *dest, void *src, size_t count)

---

Detailed Description

Provides the Registers class, which initializes with a suite of accessors suitable for reading and writing the UM7 registers, including byte-order conversion and scaling handled.

Author:

Mike Purvis <mpurvis@clearpathrobotics.com> wrote original code for UM6

Copyright:

Copyright (c) 2013, Clearpath Robotics, Inc.

Author:

Alex Brown <rbirac@cox.net> adapted code for UM7

Copyright:

Copyright (c) 2015, Alex Brown

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file registers.h.

---

Define Documentation

#define NUM_REGISTERS   (DATA_REG_START_ADDRESS + DATA_ARRAY_SIZE)

Definition at line 59 of file registers.h.

#define TO_DEGREES   (180.0 / M_PI)

Definition at line 55 of file registers.h.

#define TO_RADIANS   (M_PI / 180.0)

Definition at line 54 of file registers.h.