FXOS8700-FreeFall-Demo.spin2

{
----------------------------------------------------------------------------------------------------
    Filename:       FXOS8700-FreeFall-Demo.spin2
    Description:    Demo of the FXOS8700 driver
        * Free-fall detection functionality
    Author:         Jesse Burt
    Started:        Nov 20, 2021
    Updated:        Jul 10, 2024
    Copyright (c) 2024 - See end of file for terms of use.
----------------------------------------------------------------------------------------------------
}

CON

    _clkfreq    = cfg._clkfreq_def
    _xtlfreq    = cfg._xtlfreq

#include "core.con.click.spin2"
' -- User-modifiable constants
    CLICK_BASE  = 16                            ' MikroE Click board base I/O pin (multiple of 16)
'--

OBJ

    cfg:    "boardcfg.p2eval"

    { MikroE Click boards (change CLICK_BASE above) }
    'sensor: "sensor.imu.6dof.fxos8700" | SCL=SCL_PIN, SDA=SDA_PIN, I2C_FREQ=400_000, I2C_ADDR=%11

    { custom I/O settings }
    sensor: "sensor.imu.6dof.fxos8700" | SCL=0, SDA=1, I2C_FREQ=400_000, I2C_ADDR=%11, RST_PIN=-1

    ser:    "com.serial.terminal.ansi" | SER_BAUD=2_000_000


VAR

    long _isr_stack[50]                         ' stack for ISR core
    long _intflag                               ' interrupt flag


PUB main() | intsource, temp

    setup()
    sensor.preset_freefall()                    ' default settings, but enable
                                                ' sensors, set scale factors,
                                                ' and free-fall parameters
    ser.pos_xy(0, 5)
    ser.str(@"Sensor stable       ")

    ' The demo continuously displays the current accelerometer data.
    ' When the sensor detects free-fall, a message is displayed and
    '   is cleared after the user presses a key
    ' The preset for free-fall detection sets a free-fall threshold of
    '   0.315g's for a minimum time of 30ms. This can be tuned using
    '   sensor.freefall_thresh() and sensor.freefall_time():
    sensor.freefall_thresh(0_315000)            ' 0.315g's
    sensor.freefall_time(30_000)                ' 30_000us/30ms
    repeat
        ser.pos_xy(0, 3)
        show_accel_data()                       ' show accel data
        if ( _intflag )                         ' interrupt triggered
            intsource := sensor.accel_int()
            if ( intsource & sensor.INT_FFALL ) ' free-fall event
                temp := sensor.in_freefall()    ' clear the free-fall interrupt
            ser.pos_xy(0, 5)
            ser.strln(@"Sensor in free-fall!")
            ser.str(@"Press any key to reset")
            ser.getchar()                       ' wait for keypress
            ser.pos_x(0)
            ser.clear_line()
            ser.pos_xy(0, 5)
            ser.str(@"Sensor stable       ")
        if ( ser.getchar_noblock() == "c")      ' press the 'c' key in the demo
            cal_accel()                         ' to calibrate sensor offsets


PRI cog_isr()
' Interrupt service routine
    pinf(INT1)                                  ' INT1 as input
    repeat
        if (pinr(INT1) == 0)                    ' wait for INT1 (active low)
            _intflag := 1                       '   set flag
        elseif (pinr(INT1) == 1)                ' now wait for it to clear
            _intflag := 0                       '   clear flag


PUB setup()

    ser.start()

    ser.clear()
    ser.strln(@"Serial terminal started")

    if ( sensor.start() )
        ser.strln(@"FXOS8700 driver started")
    else
        ser.strln(@"FXOS8700 driver failed to start - halting")
        repeat

    cogspin(NEWCOG, cog_isr(), @_isr_stack)     ' start ISR in another core

#include "acceldemo.common.spin2h"


DAT
{
Copyright 2024 Jesse Burt

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.
}