rpisensehat.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * 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.
 */
#ifndef _ULTIBO_RPISENSEHAT_H
#define _ULTIBO_RPISENSEHAT_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/gpio.h"
#include "ultibo/i2c.h"
#include "ultibo/keyboard.h"
#include "ultibo/framebuffer.h"

#define RPISENSE_SIGNATURE  0xEAEBECED

#define RPISENSE_FRAMEBUFFER_DESCRIPTION    "Raspberry Pi Sense HAT Framebuffer" 
 
#define RPISENSE_PHYSICAL_WIDTH 8
#define RPISENSE_PHYSICAL_HEIGHT    8

#define RPISENSE_JOYSTICK_DESCRIPTION   "Raspberry Pi Sense HAT Joystick" 
 
static const uint16_t RPISENSE_JOYSTICK_KEYMAP[5] = {
 SCAN_CODE_DOWN_ARROW,
 SCAN_CODE_RIGHT_ARROW,
 SCAN_CODE_UP_ARROW,
 SCAN_CODE_ENTER,
 SCAN_CODE_LEFT_ARROW};

#define RPISENSE_FB 0x00
#define RPISENSE_WAI    0xF0
#define RPISENSE_VER    0xF1
#define RPISENSE_KEYS   0xF2
#define RPISENSE_EE_WP  0xF3

#define RPISENSE_GAMMA_VALUES_DEFAULT   0
#define RPISENSE_GAMMA_VALUES_LOW   1
#define RPISENSE_GAMMA_VALUES_USER  2

typedef struct _RPISENSE RPISENSE;
struct _RPISENSE
{
    uint32_t signature; 
    I2C_DEVICE *i2c; 
    GPIO_DEVICE *gpio; 
    FRAMEBUFFER_DEVICE *framebuffer; 
    KEYBOARD_DEVICE *joystick; 
};
 
typedef struct _RPISENSE_FRAMEBUFFER RPISENSE_FRAMEBUFFER;
struct _RPISENSE_FRAMEBUFFER
{
    // Framebuffer Properties
    FRAMEBUFFER_DEVICE framebuffer;
    // RPiSense Properties
    I2C_DEVICE *i2c; 
    uint32_t width; 
    uint32_t height; 
    uint32_t rotation; 
    uint32_t dirtyy1; 
    uint32_t dirtyy2; 
    LONGBOOL ready; 
    LONGBOOL blank; 
    MUTEX_HANDLE lock; 
    TIMER_HANDLE timer; 
    uint32_t framerate; 
    uint8_t gamma[32]; 
    uint8_t gammauser[32]; 
    uint16_t pixeldata[64]; 
    uint8_t blockdata[193]; 
};
 
 
typedef struct _RPISENSE_JOYSTICK RPISENSE_JOYSTICK;
struct _RPISENSE_JOYSTICK
{
    // Keyboard Properties
    KEYBOARD_DEVICE keyboard;
    // RPiSense Properties
    I2C_DEVICE *i2c; 
    GPIO_DEVICE *gpio; 
    uint32_t pin; 
    uint32_t trigger; 
    int32_t previouskeys; 
    // Statistics Properties
    uint32_t callbackcount; 
};


HANDLE STDCALL rpisense_start(char *i2cdevice, char *gpiodevice, uint32_t rotation, uint32_t width, uint32_t height);

BOOL STDCALL rpisense_stop(HANDLE handle);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_RPISENSEHAT_H