ok

Fork of HMC5843 by Jose R Padron

Embed: (wiki syntax)

« Back to documentation index

HMC5843 Class Reference

HMC5843 Class Reference

Honeywell HMC5843 digital compass. More...

#include <HMC5843.h>

Public Member Functions

 HMC5843 (PinName sda, PinName scl)
 Constructor.
void setSleepMode ()
 Enter into sleep mode.
void setDefault ()
 Set Device in Default Mode.
void getAddress (char *address)
 Perform Self Test.
void setOpMode (int mode, int ConfigA, int ConfigB)
 Set the operation mode.
void write (int address, int data)
 Write to on the device.

Detailed Description

Honeywell HMC5843 digital compass.

Definition at line 117 of file HMC5843.h.


Constructor & Destructor Documentation

HMC5843 ( PinName  sda,
PinName  scl 
)

Constructor.

Includes.

Parameters:
sdambed pin to use for SDA line of I2C interface.
sclmbed pin to use for SCL line of I2C interface.
Author:
Jose R. Padron
Used HMCHMC6352 library developed by Aaron Berk as template

LICENSE

Copyright (c) 2010 ARM Limited

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

DESCRIPTION

Honeywell HMC5843digital compass.

Datasheet:

http://www.ssec.honeywell.com/magnetic/datasheets/HMC5843.pdf

Definition at line 40 of file HMC5843.cpp.


Member Function Documentation

void getAddress ( char *  address )

Perform Self Test.

Read the memory location on the device which contains the address.

Parameters:
Pointerto a buffer to hold the address value Expected H, 4 and 3.

Definition at line 84 of file HMC5843.cpp.

void setDefault ( void   )

Set Device in Default Mode.

HMC5843_CONTINUOUS, HMC5843_10HZ_NORMAL HMC5843_1_0GA

Definition at line 69 of file HMC5843.cpp.

void setOpMode ( int  mode,
int  ConfigA,
int  ConfigB 
)

Set the operation mode.

Parameters:
mode0x00 -> Continuous 0x01 -> Single 0x02 -> Idle
ConfigAvalues
ConfigBvalues

Definition at line 104 of file HMC5843.cpp.

void setSleepMode (  )

Enter into sleep mode.

Definition at line 64 of file HMC5843.cpp.

void write ( int  address,
int  data 
)

Write to on the device.

Parameters:
addressAddress to write to.
dataData to write.

Definition at line 50 of file HMC5843.cpp.