Difference between revisions of "Unit RPISENSEHAT"

From Ultibo.org
Jump to: navigation, search
Line 350: Line 350:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Called only during system startup
 
| Called only during system startup
 
|-
 
|-
Line 362: Line 362:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''I2C'''
+
! I2C
 
| The name of the I2C device that the SenseHat is connected to
 
| The name of the I2C device that the SenseHat is connected to
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The name of the GPIO device that the SenseHat is connected to
 
| The name of the GPIO device that the SenseHat is connected to
 
|-
 
|-
−
! '''Rotation'''
+
! Rotation
 
| The rotation value of the framebuffer (eg FRAMEBUFFER_ROTATION_180)
 
| The rotation value of the framebuffer (eg FRAMEBUFFER_ROTATION_180)
 
|-
 
|-
−
! '''Width'''
+
! Width
 
| The width of the framebuffer in pixels (Virtual width only, the Physical width is fixed at 8 pixels)
 
| The width of the framebuffer in pixels (Virtual width only, the Physical width is fixed at 8 pixels)
 
|-
 
|-
−
! '''Height'''
+
! Height
 
| The height of the framebuffer in pixels (Virtual height only, the Physical height is fixed at 8 pixels)
 
| The height of the framebuffer in pixels (Virtual height only, the Physical height is fixed at 8 pixels)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The handle of the RPiSenseHat on success or INVALID_HANDLE_VALUE on failure
 
| The handle of the RPiSenseHat on success or INVALID_HANDLE_VALUE on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| This function will be called during startup if the parameter RPISENSE_AUTOSTART is True
 
| This function will be called during startup if the parameter RPISENSE_AUTOSTART is True
 
|-
 
|-
Line 392: Line 392:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Handle'''
+
! Handle
 
| The handle of the RPiSenseHat or INVALID_HANDLE_VALUE for the default
 
| The handle of the RPiSenseHat or INVALID_HANDLE_VALUE for the default
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| True if completed or False on failure
 
| True if completed or False on failure
 
|-
 
|-
Line 410: Line 410:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''I2C'''
+
! I2C
 
| The I2C device that the RPiSenseHat is connected to
 
| The I2C device that the RPiSenseHat is connected to
 
|-
 
|-
−
! '''Name'''
+
! Name
 
| The text description of this device which will show in the device list (Optional)
 
| The text description of this device which will show in the device list (Optional)
 
|-
 
|-
−
! '''Rotation'''
+
! Rotation
 
| The rotation value of the framebuffer (eg FRAMEBUFFER_ROTATION_180)
 
| The rotation value of the framebuffer (eg FRAMEBUFFER_ROTATION_180)
 
|-
 
|-
−
! '''Width'''
+
! Width
 
| The width of the framebuffer in pixels (Virtual width only, the Physical width is fixed at 8 pixels)
 
| The width of the framebuffer in pixels (Virtual width only, the Physical width is fixed at 8 pixels)
 
|-
 
|-
−
! '''Height'''
+
! Height
 
| The height of the framebuffer in pixels (Virtual height only, the Physical height is fixed at 8 pixels)
 
| The height of the framebuffer in pixels (Virtual height only, the Physical height is fixed at 8 pixels)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to the new Framebuffer device or nil if the framebuffer device could not be created
 
| Pointer to the new Framebuffer device or nil if the framebuffer device could not be created
 
|-
 
|-
Line 437: Line 437:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Framebuffer'''
+
! Framebuffer
 
| The Framebuffer device to destroy
 
| The Framebuffer device to destroy
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 452: Line 452:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Not intended to be called directly by applications, use FramebufferDeviceAllocate instead
+
| Not intended to be called directly by applications, use FramebufferDeviceAllocate instead.
 
|-
 
|-
 
|}
 
|}
Line 464: Line 464:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Not intended to be called directly by applications, use FramebufferDeviceRelease instead
+
| Not intended to be called directly by applications, use FramebufferDeviceRelease instead.
 
|-
 
|-
 
|}
 
|}
Line 476: Line 476:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Not intended to be called directly by applications, use FramebufferDevicBlank instead
+
| Not intended to be called directly by applications, use FramebufferDevicBlank instead.
 
|-
 
|-
 
|}
 
|}
Line 488: Line 488:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Not intended to be called directly by applications, use FramebufferDeviceMark instead
+
| Not intended to be called directly by applications, use FramebufferDeviceMark instead.
 
Marks full lines only, X and Width are ignored for RPiSenseHat Framebuffer
 
Marks full lines only, X and Width are ignored for RPiSenseHat Framebuffer
 
|-
 
|-
Line 501: Line 501:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Not intended to be called directly by applications, use FramebufferDeviceCommit instead
+
| Not intended to be called directly by applications, use FramebufferDeviceCommit instead.
 
|-
 
|-
 
|}
 
|}
Line 513: Line 513:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Not intended to be called directly by applications, use FramebufferDeviceSetOffset instead
+
| Not intended to be called directly by applications, use FramebufferDeviceSetOffset instead.
 
|-
 
|-
 
|}
 
|}
Line 525: Line 525:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Not intended to be called directly by applications, use FramebufferDeviceSetProperties instead
+
| Not intended to be called directly by applications, use FramebufferDeviceSetProperties instead.
 
|-
 
|-
 
|}
 
|}
Line 537: Line 537:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Framebuffer'''
+
! Framebuffer
 
| The Framebuffer device to get from
 
| The Framebuffer device to get from
 
|-
 
|-
−
! '''Gamma'''
+
! Gamma
 
| An array of gamma values returned on completion
 
| An array of gamma values returned on completion
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 555: Line 555:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Framebuffer'''
+
! Framebuffer
 
| The Framebuffer device to set for
 
| The Framebuffer device to set for
 
|-
 
|-
−
! '''Gamma'''
+
! Gamma
 
| An array of gamma values to set
 
| An array of gamma values to set
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 573: Line 573:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Framebuffer'''
+
! Framebuffer
 
| The Framebuffer device to set for
 
| The Framebuffer device to set for
 
|-
 
|-
−
! '''Value'''
+
! Value
 
| The gamma values to set (0 = Default / 1 = Low / 2 = User)
 
| The gamma values to set (0 = Default / 1 = Low / 2 = User)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 591: Line 591:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 603: Line 603:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Not intended to be called directly by applications
 
| Not intended to be called directly by applications
 
|-
 
|-
Line 618: Line 618:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''I2C'''
+
! I2C
 
| The I2C device that the RPiSenseHat is connected to
 
| The I2C device that the RPiSenseHat is connected to
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device that the RPiSenseHat is connected to
 
| The GPIO device that the RPiSenseHat is connected to
 
|-
 
|-
−
! '''Name'''
+
! Name
 
| The text description of this device which will show in the device list (Optional)
 
| The text description of this device which will show in the device list (Optional)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to the new Joystick (Keyboard) device or nil if the device could not be created
 
| Pointer to the new Joystick (Keyboard) device or nil if the device could not be created
 
|-
 
|-
Line 639: Line 639:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Joystick'''
+
! Joystick
 
| The Joystick (Keyboard) device to destroy
 
| The Joystick (Keyboard) device to destroy
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 654: Line 654:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Not intended to be called directly by applications
 
| Not intended to be called directly by applications
 
|-
 
|-
Line 669: Line 669:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''I2C'''
+
! I2C
 
| The I2C device the RPiSenseHat is connected to
 
| The I2C device the RPiSenseHat is connected to
 
|-
 
|-
−
! '''Address'''
+
! Address
 
| The I2C address of the RPiSenseHat
 
| The I2C address of the RPiSenseHat
 
|-
 
|-
−
! '''Reg'''
+
! Reg
 
| The register to read
 
| The register to read
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The register value on success or -1 on failure
 
| The register value on success or -1 on failure
 
|-
 
|-
Line 690: Line 690:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''I2C'''
+
! I2C
 
| The I2C device the RPiSenseHat is connected to
 
| The I2C device the RPiSenseHat is connected to
 
|-
 
|-
−
! '''Address'''
+
! Address
 
| The I2C address of the RPiSenseHat
 
| The I2C address of the RPiSenseHat
 
|-
 
|-
−
! '''Data'''
+
! Data
 
| Pointer to the data block to be written
 
| Pointer to the data block to be written
 
|-
 
|-
−
! '''Size'''
+
! Size
 
| Size of the data block in bytes
 
| Size of the data block in bytes
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-

Revision as of 05:18, 24 April 2018

Return to Unit Reference


Description

Raspberry Pi SenstHat Driver unit

The SenseHAT 8x8 LED matrix is presented in Ultibo as an 8x8 pixel framebuffer. This allows full access to the display at both the individual pixel level and also using the higher level console functions to display text and graphics on the matrix.

The framebuffer device supports rotation around the full 360 degrees by supplying the required rotation value in the framebuffer properties when calling FramebufferAllocate() or by calling the SenseHAT specific function RPiSenseFramebufferSetRotation().

As per the official Python libraries, the default rotation (FRAMEBUFFER_ROTATION_0) gives correct viewing when the HDMI port is facing downwards.

The SenseHAT joystick appears as a keyboard device and the pressed buttons are received as key presses that represent the Left, Right, Up, Down and Enter keys.

Constants


[Expand]
RPiSenseHat specific constants RPISENSE_*


[Expand]
Framebuffer RPISENSE_FRAMEBUFFER_*


[Expand]
Joystick RPISENSE_JOYSTICK_*


[Expand]
RPiSenseHat register value RPISENSE_FB*


[Expand]
RPiSenseHat gamma reset value RPISENSE_GAMMA_*


Type definitions


RPi sense

[Expand]

PRPiSense = ^TRPiSense;

TRPiSense = record

RPi sense gamma

[Expand]

PRPiSenseGamma = ^TRPiSenseGamma;

TRPiSenseGamma = array[0..31] of Byte;

RPi sense framebuffer

[Expand]

PRPiSenseFramebuffer = ^TRPiSenseFramebuffer;

TRPiSenseFramebuffer = record

RPi sense joystick

[Expand]

PRPiSenseJoystick = ^TRPiSenseJoystick;

TRPiSenseJoystick = record


Public variables


RPiSenseHat specific variables

RPISENSE_I2C_DEVICE:String = 'I2C0';
RPISENSE_GPIO_DEVICE:String = 'GPIO0';
RPISENSE_FRAMEBUFFER_ROTATION:LongWord = FRAMEBUFFER_ROTATION_0;
RPISENSE_FRAMEBUFFER_WIDTH:LongWord = RPISENSE_PHYSICAL_WIDTH;
RPISENSE_FRAMEBUFFER_HEIGHT:LongWord = RPISENSE_PHYSICAL_HEIGHT;
RPISENSE_I2C_ADDRESS:Word = $46;
RPISENSE_LSM9DS1_MAGN_ADDRESS:Word = $1C;
RPISENSE_LSM9DS1_ACCEL_ADDRESS:Word = $6A;
RPISENSE_LPS25H_PRESS_ADDRESS:Word = $5C;
RPISENSE_HTS221_HUMID_ADDRESS:Word = $5F;


Function declarations


Initialization functions

[Expand] 
procedure RPiSenseInit;
Description: Initialize the RPiSenseHat unit and parameters


[Expand] 
function RPiSenseStart(const I2CDevice,GPIODevice:String; Rotation,Width,Height:LongWord):THandle;
Description: Start the RPiSenseHat driver and register the Framebuffer and Joystick devices


[Expand] 
function RPiSenseStop(Handle:THandle):Boolean;
Description: Stop the RPiSenseHat driver and deregister the Framebuffer and Joystick devices


RPiSenseHat framebuffer functions

[Expand] 
function RPiSenseFramebufferCreate(I2C:PI2CDevice; const Name:String; Rotation,Width,Height:LongWord):PFramebufferDevice;
Description: Create, register and allocate a new RPiSenseHat Framebuffer device which can be accessed using the framebuffer API


[Expand] 
function RPiSenseFramebufferDestroy(Framebuffer:PFramebufferDevice):LongWord;
Description: Release, deregister and destroy an RPiSenseHat Framebuffer device created by this driver}


[Expand] 
function RPiSenseFramebufferAllocate(Framebuffer:PFramebufferDevice; Properties:PFramebufferProperties):LongWord;
Description: Implementation of FramebufferDeviceAllocate API for RPiSenseHat Framebuffer


[Expand] 
function RPiSenseFramebufferRelease(Framebuffer:PFramebufferDevice):LongWord;
Description: Implementation of FramebufferDeviceRelease API for RPiSenseHat Framebuffer


[Expand] 
function RPiSenseFramebufferBlank(Framebuffer:PFramebufferDevice; Blank:Boolean):LongWord;
Description: Implementation of FramebufferDevicBlank API for RPiSenseHat Framebuffer


[Expand] 
function RPiSenseFramebufferMark(Framebuffer:PFramebufferDevice; X,Y,Width,Height,Flags:LongWord):LongWord;
Description: Implementation of FramebufferDeviceMark API for RPiSenseHat Framebuffer


[Expand] 
function RPiSenseFramebufferCommit(Framebuffer:PFramebufferDevice; Address,Size,Flags:LongWord):LongWord;
Description: Implementation of FramebufferDeviceCommit API for RPiSenseHat Framebuffer


[Expand] 
function RPiSenseFramebufferSetOffset(Framebuffer:PFramebufferDevice; X,Y:LongWord; Pan:Boolean):LongWord;
Description: Implementation of FramebufferDeviceSetOffset API for RPiSenseHat Framebuffer


[Expand] 
function RPiSenseFramebufferSetProperties(Framebuffer:PFramebufferDevice; Properties:PFramebufferProperties):LongWord;
Description: Implementation of FramebufferDeviceSetProperties API for RPiSenseHat Framebuffer


[Expand] 
function RPiSenseFramebufferGetGamma(Framebuffer:PFramebufferDevice; var Gamma:TRPiSenseGamma):LongWord;
Description: Get the current gamma values from the RPiSenseHat framebuffer


[Expand] 
function RPiSenseFramebufferSetGamma(Framebuffer:PFramebufferDevice; const Gamma:TRPiSenseGamma):LongWord;
Description: Set the current gamma values for the RPiSenseHat framebuffer


[Expand] 
function RPiSenseFramebufferResetGamma(Framebuffer:PFramebufferDevice; Value:LongWord):LongWord;
Description: Reset the current gamma values for the RPiSenseHat framebuffer to Default, Low or User


[Expand] 
function RPiSenseFramebufferSetRotation(Framebuffer:PFramebufferDevice; Rotation:LongWord):LongWord;
Description: To be documented


[Expand] 
procedure RPiSenseFramebufferUpdateDisplay(Framebuffer:PRPiSenseFramebuffer);
Description: Timer function for RPiSenseHat framebuffer dirty region redraw


RPiSenseHat joystick functions

[Expand] 
function RPiSenseJoystickCreate(I2C:PI2CDevice; GPIO:PGPIODevice; const Name:String):PKeyboardDevice;
Description: Create, register and attach a new RPiSenseHat Joystick device which can be accessed using the keyboard API


[Expand] 
function RPiSenseJoystickDestroy(Joystick:PKeyboardDevice):LongWord;
Description: Detach, deregister and destroy a RPiSenseHat Joystick device created by this driver


[Expand] 
procedure RPiSenseJoystickCallback(Joystick:PRPiSenseJoystick; Pin,Trigger:LongWord);
Description: Callback function for the RPiSenseHat Joystick device, called on a worker thread when the registered GPIO event is triggered by a rising edge on the specified pin


RPiSenseHat helper functions

[Expand] 
function RPiSenseRegRead(I2C:PI2CDevice; Address:Word; Reg:Byte):LongInt;
Description: Read a byte from an RPiSenseHat register


[Expand] 
function RPiSenseBlockWrite(I2C:PI2CDevice; Address:Word; Data:PByte; Size:Integer):LongWord;
Description: Write a block of data to the RPiSenseHat


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_RPISENSEHAT&oldid=3809"