Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ruanhaishen
Nodemcu Firmware
Commits
bb9e2104
Commit
bb9e2104
authored
Jun 05, 2016
by
Jason Schmidlapp
Committed by
Marcel Stör
Jun 05, 2016
Browse files
Added support for Honeywell HMC5883L digital compass (#1253)
parent
4a1775c2
Changes
4
Hide whitespace changes
Inline
Side-by-side
app/include/user_modules.h
View file @
bb9e2104
...
...
@@ -31,6 +31,7 @@
//#define LUA_USE_MODULES_ENDUSER_SETUP // USE_DNS in dhcpserver.h needs to be enabled for this module to work.
#define LUA_USE_MODULES_FILE
#define LUA_USE_MODULES_GPIO
//#define LUA_USE_MODULES_HMC5883L
//#define LUA_USE_MODULES_HTTP
//#define LUA_USE_MODULES_HX711
#define LUA_USE_MODULES_I2C
...
...
app/modules/hmc5883l.c
0 → 100644
View file @
bb9e2104
/*
* Driver for Honeywell HMC5883L compass IC
*
* Code based on BMP085 driver.
*/
#include "module.h"
#include "lauxlib.h"
#include "platform.h"
#include "c_stdlib.h"
#include "c_string.h"
static
const
uint32_t
hmc5883_i2c_id
=
0
;
static
const
uint8_t
hmc5883_i2c_addr
=
0x1E
;
static
uint8_t
ICACHE_FLASH_ATTR
r8u
(
uint32_t
id
,
uint8_t
reg
)
{
uint8_t
ret
;
platform_i2c_send_start
(
id
);
platform_i2c_send_address
(
id
,
hmc5883_i2c_addr
,
PLATFORM_I2C_DIRECTION_TRANSMITTER
);
platform_i2c_send_byte
(
id
,
reg
);
platform_i2c_send_stop
(
id
);
platform_i2c_send_start
(
id
);
platform_i2c_send_address
(
id
,
hmc5883_i2c_addr
,
PLATFORM_I2C_DIRECTION_RECEIVER
);
ret
=
platform_i2c_recv_byte
(
id
,
0
);
platform_i2c_send_stop
(
id
);
return
ret
;
}
static
void
ICACHE_FLASH_ATTR
w8u
(
uint32_t
id
,
uint8_t
reg
,
uint8_t
val
)
{
platform_i2c_send_start
(
hmc5883_i2c_id
);
platform_i2c_send_address
(
hmc5883_i2c_id
,
hmc5883_i2c_addr
,
PLATFORM_I2C_DIRECTION_TRANSMITTER
);
platform_i2c_send_byte
(
hmc5883_i2c_id
,
reg
);
platform_i2c_send_byte
(
hmc5883_i2c_id
,
val
);
platform_i2c_send_stop
(
hmc5883_i2c_id
);
}
static
int
ICACHE_FLASH_ATTR
hmc5883_init
(
lua_State
*
L
)
{
uint32_t
sda
;
uint32_t
scl
;
uint8_t
devid_a
,
devid_b
,
devid_c
;
sda
=
luaL_checkinteger
(
L
,
1
);
scl
=
luaL_checkinteger
(
L
,
2
);
luaL_argcheck
(
L
,
sda
>
0
&&
scl
>
0
,
1
,
"no i2c for D0"
);
platform_i2c_setup
(
hmc5883_i2c_id
,
sda
,
scl
,
PLATFORM_I2C_SPEED_SLOW
);
devid_a
=
r8u
(
hmc5883_i2c_id
,
10
);
devid_b
=
r8u
(
hmc5883_i2c_id
,
11
);
devid_c
=
r8u
(
hmc5883_i2c_id
,
12
);
if
((
devid_a
!=
0x48
)
||
(
devid_b
!=
0x34
)
||
(
devid_c
!=
0x33
))
{
return
luaL_error
(
L
,
"device not found"
);
}
// 8 sample average, 15 Hz update rate, normal measurement
w8u
(
hmc5883_i2c_id
,
0x00
,
0x70
);
// Gain = 5
w8u
(
hmc5883_i2c_id
,
0x01
,
0xA0
);
// Continuous measurement
w8u
(
hmc5883_i2c_id
,
0x02
,
0x00
);
return
0
;
}
static
int
ICACHE_FLASH_ATTR
hmc5883_read
(
lua_State
*
L
)
{
uint8_t
data
[
6
];
int
x
,
y
,
z
;
int
i
;
platform_i2c_send_start
(
hmc5883_i2c_id
);
platform_i2c_send_address
(
hmc5883_i2c_id
,
hmc5883_i2c_addr
,
PLATFORM_I2C_DIRECTION_TRANSMITTER
);
platform_i2c_send_byte
(
hmc5883_i2c_id
,
0x03
);
platform_i2c_send_stop
(
hmc5883_i2c_id
);
platform_i2c_send_start
(
hmc5883_i2c_id
);
platform_i2c_send_address
(
hmc5883_i2c_id
,
hmc5883_i2c_addr
,
PLATFORM_I2C_DIRECTION_RECEIVER
);
for
(
i
=
0
;
i
<
5
;
i
++
)
{
data
[
i
]
=
platform_i2c_recv_byte
(
hmc5883_i2c_id
,
1
);
}
data
[
5
]
=
platform_i2c_recv_byte
(
hmc5883_i2c_id
,
0
);
platform_i2c_send_stop
(
hmc5883_i2c_id
);
x
=
(
int16_t
)
((
data
[
0
]
<<
8
)
|
data
[
1
]);
y
=
(
int16_t
)
((
data
[
2
]
<<
8
)
|
data
[
3
]);
z
=
(
int16_t
)
((
data
[
4
]
<<
8
)
|
data
[
5
]);
lua_pushinteger
(
L
,
x
);
lua_pushinteger
(
L
,
y
);
lua_pushinteger
(
L
,
z
);
return
3
;
}
static
const
LUA_REG_TYPE
hmc5883_map
[]
=
{
{
LSTRKEY
(
"read"
),
LFUNCVAL
(
hmc5883_read
)},
{
LSTRKEY
(
"init"
),
LFUNCVAL
(
hmc5883_init
)},
{
LNILKEY
,
LNILVAL
}
};
NODEMCU_MODULE
(
HMC5883L
,
"hmc5883l"
,
hmc5883_map
,
NULL
);
docs/en/modules/hmc5883l.md
0 → 100644
View file @
bb9e2104
# HMC5883L Module
| Since | Origin / Contributor | Maintainer | Source |
| :----- | :-------------------- | :---------- | :------ |
| 2016-04-09 |
[
Jason Schmidlapp
](
https://github.com/jschmidlapp
)
|
[
Jason Schmidlapp
](
https://github.com/jschmidlapp
)
|
[
hmc5883l.c
](
../../../app/modules/hmc5883l.c
)
|
This module provides access to the
[
HMC5883L
](
https://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf
)
three axis digital compass.
## hmc5883l.read()
Samples the sensor and returns X,Y and Z data.
#### Syntax
`hmc5883l.read()`
#### Returns
x,y,z measurements (integers)
temperature multiplied with 10 (integer)
#### Example
```
lua
hmc5883
.
init
(
1
,
2
)
local
x
,
y
,
z
=
hmc5883l
.
read
()
print
(
string.format
(
"x = %d, y = %d, z = %d"
,
x
,
y
,
z
))
```
## hmc5883l.init()
Initializes the module and sets the pin configuration.
#### Syntax
`hmc5883l.init(sda, scl)`
#### Parameters
-
`sda`
data pin
-
`scl`
clock pin
#### Returns
`nil`
mkdocs.yml
View file @
bb9e2104
...
...
@@ -47,6 +47,7 @@ pages:
-
'
enduser
setup'
:
'
en/modules/enduser-setup.md'
-
'
file'
:
'
en/modules/file.md'
-
'
gpio'
:
'
en/modules/gpio.md'
-
'
hmc5883l'
:
'
en/modules/hmc5883l.md'
-
'
http'
:
'
en/modules/http.md'
-
'
hx711'
:
'
en/modules/hx711.md'
-
'
i2c'
:
'
en/modules/i2c.md'
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment