FXOS8700-ClickDemo.spin2

{
----------------------------------------------------------------------------------------------------
    Filename:       FXOS8700-ClickDemo.spin2
    Description:    Demo of the FXOS8700 driver
        * click-detection functionality
    Author:         Jesse Burt
    Started:        Nov 19, 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


PUB main() | click_src, int_act, dclicked, sclicked, z_clicked, y_clicked, x_clicked

    setup()
    sensor.preset_click_det()                   ' preset settings for click-detection

    ser.hide_cursor()                           ' hide terminal cursor

    repeat until (ser.getchar_noblock() == "q") ' press q to quit
        click_src := sensor.clicked_int()
        int_act := ((click_src >> 7) & 1)
        dclicked := ((click_src >> 3) & 1)
        sclicked := ((click_src >> 7) & 1)
        z_clicked := ((click_src >> 6) & 1)
        y_clicked := ((click_src >> 5) & 1)
        x_clicked := ((click_src >> 4) & 1)
        ser.pos_xy(0, 3)
        ser.printf(@"Click interrupt: %s\n\r", yesno(int_act))
        ser.printf(@"Double-clicked:  %s\n\r", yesno(dclicked))
        ser.printf(@"Single-clicked:  %s\n\r", yesno(sclicked))
        ser.printf(@"Z-axis clicked:  %s\n\r", yesno(z_clicked))
        ser.printf(@"Y-axis clicked:  %s\n\r", yesno(y_clicked))
        ser.printf(@"X-axis clicked:  %s\n\r", yesno(x_clicked))

    ser.show_cursor()                           ' restore terminal cursor
    repeat


PRI yesno(val): resp
' Return pointer to string "Yes" or "No" depending on value called with
    if ( val )
        return @"Yes"
    else
        return @"No "


PUB setup()

    ser.start()

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

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


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