-spec config(component(), #{}) -> ok.

Change configurations.

Examples

To switch to accelerometer only mode, i.e., power down the gyroscope, use:

2> pmod_nav:config(acc, #{odr_g => power_down}).
okcopy

To turn the gyroscope back on use:

3> pmod_nav:config(acc, #{odr_g => {hz,14.9}}).
okcopy

For more possible configurations see the datasheets LSM9DS1 and LPS25HB.

Use registers/0 and registers/1 to see the mapping between Erlang expressions and the bits on the hardware.

-spec read(component(), [register()]) -> any() | {error, any()}.

Equivalent to read(Comp, Registers, #{}).

-spec read(component(), [register()], opts()) -> any() | {error, any()}.

Read registers of a component.

Examples

To read the accelerometer X, Y and Z axises G-forces in milli g, use:

 4> pmod_nav:read(acc, [out_x_xl, out_y_xl, out_z_xl], #{xl_unit => mg}).
 [50.813,6.527,983.7470000000001]copy

Further Registers

For all registers see registers/0 and registers/1 and use the datasheets LPS25HB and LPS25HB for a complete description.

-spec registers() -> #{component() => #{}}.

Get the registers (with the possible entries) of all components.

-spec registers(component()) -> #{atom() => any()}.

Get the registers (with the possible entries) of one component.

Example

To see the possible configurations in ctrl_reg1_g use:

4> maps:find(ctrl_reg1_g, pmod_nav:registers(acc)).
{ok,{16,read_write,1,
     [{odr_g,3,
             #{power_down => 0,
               {hz,119} => 3,
               {hz,238} => 4,
               {hz,476} => 5,
               {hz,952} => 6,
               {hz,14.9} => 1,
               {hz,59.5} => 2}},
      {fs_g,2,#{{dps,245} => 0,{dps,500} => 1,{dps,2000} => 3}},
      {0,1},
      {bw_g,2,raw}]}}copy