BBQ20KBD-Demo.spin

{
----------------------------------------------------------------------------------------------------
    Filename:       BBQ20KBD-Demo.spin
    Description:    Demo of the BBQ20KBD driver
    Author:         Jesse Burt
    Started:        Dec 30, 2022
    Updated:        Aug 24, 2024
    Copyright (c) 2024 - See end of file for terms of use.
----------------------------------------------------------------------------------------------------
}

CON

    _clkmode    = xtal1+pll16x
    _xinfreq    = 5_000_000


OBJ

    time:   "time"
    ser:    "com.serial.terminal.ansi" | SER_BAUD=115_200
    keybd:  "input.keyboard.bbq20kbd" | SCL=28, SDA=29, I2C_FREQ=400_000


PUB main()

    setup()
    repeat
        ser.clear()
        ser.pos_xy(0, 0)
        ser.strln(@"Press a key to run a demo:")
        ser.strln(@"k, K: keyboard/keypress demo")
        ser.strln(@"t, T: trackpad demo")

        case ser.getchar()
            "k", "K":
                keypress_demo()
            "t", "T":
                trackpad_demo()
            other:
                next


PUB keypress_demo() | ch
' Demonstrate the keyboard input capability
    ser.clear()
    ser.strln(@"Type on the BBQ20KBD and the keypresses will be shown here:")
    ser.strln(@"  Caps lock on: alt + right shift, Num lock on: alt + left shift")
    ser.strln(@"  Caps lock off: right shift, Num lock off: Left shift")
    ser.strln(@"  (press 'q' in the serial terminal to return to the main menu)")

    repeat
        if ( keybd.available() )
            ser.putchar(keybd.getchar())
    while (ser.getchar_noblock() <> "q")


PUB trackpad_demo()
' Demonstrate the trackpad input capability
    ser.clear()
    ser.strln(@"Touch the trackpad to see the position delta:")
    ser.strln(@"  (press 'q' in the serial terminal to return to the main menu)")

    ' Set the minimum and maximum absolute position for the X and Y axes
    '   (these can be anywhere from negx to posx; 0 to 1024 are used here as an example):
    keybd.set_abs_x_min(0)
    keybd.set_abs_x_max(1024)
    keybd.set_abs_y_min(0)
    keybd.set_abs_y_max(1024)

    ' set trackpad sensitivity
    '   1..8 (1 = least sensitive, 8 = most sensitive)
    keybd.set_sensitivity_x(8)
    keybd.set_sensitivity_y(8)

    repeat
        ser.pos_xy(0, 3)
        ser.printf2(@"Relative x = %4.4d\ty = %4.4d\n\r",   keybd.trackpad_rel_x(), ...
                                                            keybd.trackpad_rel_y() )
        ser.printf2(@"Absolute x = %9.9d\ty = %9.9d\n\r",   keybd.trackpad_abs_x(), ...
                                                            keybd.trackpad_abs_y() )
    while ( ser.getchar_noblock() <> "q" )


PUB setup()

    ser.start()
    time.msleep(30)
    ser.clear()
    ser.strln(@"Serial terminal started")

    if ( keybd.start() )
        ser.strln(@"BBQ20KBD driver started")
    else
        ser.strln(@"BBQ20KBD 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.
}