Difference between revisions of "Unit Reference"

Revision as of 03:26, 29 March 2024

Ultibo core includes a range of units which make up the complete API, some of these are internal to the core and are not intended to be called by applications, others provide an API which can be used to access features and functionality from within your application.

Each unit is listed below with a link to the individual documentation outlining its function and usage.

Mandatory units

• GlobalConfig - Global configuration settings and functions
• GlobalConst - Global constants and values
• GlobalTypes - Global type definitions
• GlobalStrings - Global string definitions
• Platform - Platform common support
• HeapManager - Heap (Memory) manager
• Threads - Threads, locks and scheduler
• Devices - Devices manager
• Locale - Locales and code pages
• Unicode - Unicode strings and RTL widestring manager

Generic units

• ASN.1 - Ultibo ASN.1 interface unit
• Authentication - Authentication base classes
• Big Integer - Ultibo Big Integer interface unit
• Crypto - Cryptography support module
• Font - Font manager
• Keymap - Keymap manager
• MPEG - MPEG encoding/decoding support module (Not yet implemented)
• Security - Security descriptor support module
• Shell - Shell manager
• SSL - SSL/TLS support module (Not yet implemented)
• Syscalls - C library support module
• Timezone - Timezone manager
• Ultibo - Ultibo API / Windows compatibility
• UltiboClasses - Ultibo API classes
• UltiboUtils - Ultibo API utilities
• VPN - VPN support module (Not yet implemented)
• Wiring - WiringPi API implementation
• X.509 - Ultibo X.509 interface unit

Device units

• ATAOE - ATA over Ethernet (Not yet implemented)
• ATAPI - ATA/ATAPI (Not yet implemented)
• Audio - Audio device interface / USB audio driver (Not yet implemented)
• Bluetooth - Bluetooth device interface (Not yet implemented)
• Codec - Codec device interface
• Console - Console device interface
• DAB - Digital Audio Broadcast (DAB) device interface (Not yet implemented)
• DeviceTree - Ultibo Flattened Device Tree (DTB) interface
• DFU - Device Firmware Update (USB) support module (Not yet implemented)
• DMA - DMA device interface
• DVB - Digital Video Broadcast (DVB) device interface (Not yet implemented)
• Framebuffer - Framebuffer device interface
• GraphicsConsole - Graphics Console interface
• GPIO - GPIO device interface
• HID - HID device interface
• I2C - I2C device interface
• I2S - I2S device interface (Not yet implemented)
• iSCSI - iSCSI device interface (Not yet implemented)
• Joystick - Joystick and Gamepad interface
• Keyboard - Keyboard device interface / USB keyboard driver
• Logging - Logging device interface
• MMC - MMC/SD/SDIO device/host interface
• MMCSPI - MMC SPI interface module (Not yet implemented)
• Mouse - Mouse device interface / USB mouse driver
• PCI - PCI/PCIe device interface
• PS2 - PS2 Keyboard/Mouse Controller Support
• PWM - PWM device interface
• RTC - Real Time Clock device interface
• SCSI - SCSI device interface
• Serial - Serial device interface
• SPI - SPI device interface
• Storage - Storage device interface
• TFT Framebuffer - TFT Framebuffer device interface
• Touch - Touch device interface
• UART - UART device interface
• USB - USB device/driver/host interface
• USBCDC - USB CDC device interface
• USBHID - USB HID device interface
• Video - Video device interface / USB video driver (Not yet implemented)
• W1 - 1-Wire device interface (Not yet implemented)

Hardware units

• AHCI - Advanced Host Controller Interface (AHCI) (Not yet implemented)
• ARMGIC - ARM Generic Interrupt Controller driver module
• BCM2708 - Broadcom BCM2835 SoC driver module
• BCM2709 - Broadcom BCM2836 SoC driver module
• BCM2710 - Broadcom BCM2837 SoC driver module
• BCM2711 - Broadcom BCM2838 SoC driver module
• BCM2835 - Broadcom BCM2835 SoC support module
• BCM2836 - Broadcom BCM2836 SoC support module
• BCM2837 - Broadcom BCM2837 SoC support module
• BCM2838 - Broadcom BCM2838 SoC support module
• DWCOTG - Synopsis Designware USB host controller module
• EHCI - USB EHCI host controller module (Not yet implemented)
• VC4 - VideoCore IV GPU interface module
• VC4V3D - VideoCore IV V3D interface unit
• VC4VCHIQ - VideoCore IV VCHIQ driver
• VersatilePB - Ultibo Definitions specific to the ARM Versatile Platform Baseboard
• XHCI - USB XHCI host controller module (Not yet implemented)

Network units

• ARP - ARP transport module
• DHCP - DHCP configuration module
• DNS - DNS client module
• FTP - FTP client and server classes (Not yet implemented)
• GlobalSock - Global socket constants and type definitions
• HTTP - HTTP client and server classes
• ICMP - ICMP protocol module
• ICMPv6 - ICMPv6 protocol module (Not yet implemented)
• IGMP - IGMP protocol module (Not yet implemented)
• IMAP4 - IMAP4 client and server classes
• IP - IPv4 transport module
• IPHlpAPI - IP Helper API
• IPv6 - IPv6 transport module (Not yet implemented)
• LDAP - LDAP protocol module (Not yet implemented)
• Loopback - Loopback adapter module
• Network - Network device interface / Adapter manager
• POP3 - POP3 client and server classes
• Protocol - Protocol manager
• RAW - RAW protocol module
• Services - Network services (NTP/SysLog/Telnet) classes
• SIP - SIP client and server classes (Not yet implemented)
• SMTP - SMTP client and server classes
• Sockets - Sockets interface
• TCP - TCP protocol module
• Transport - Transport manager
• UDP - UDP protocol module
• WiFi - WiFi (WPA) transport module (Not yet implemented)
• Winsock - Winsock 1.1 interface
• Winsock2 - Winsock 2.0 interface
• XMPP - XMPP client and server classes (Not yet implemented)

Filesystem units

• CDFS - CD (ISO9660/Joliet) filesystem module
• CIFS - Common Internet File System (CIFS) filesystem module (Not yet implemented)
• EXTFS - EXT2/3/4 filesystem module (Not yet implemented)
• FATFS - FAT12/16/32 filesystem module
• Filesystem - Filesystem manager
• NFS - Network File System (NFS) filesystem module (Not yet implemented)
• NTFS - NTFS filesystem module
• NTFSClass - NTFS classes
• NTFSConst - NTFS constants
• NTFSTypes - NTFS type definitions
• NTFSUtils - NTFS utility functions
• VirtualDisk - Virtual disk filesystem module

Driver units

• AF16x2LCD - Console device driver for Adafruit RGB 16x2 LCD
• BCMSDHOST - Broadcom BCM27XX SDHOST driver
• DS1307 - Real time clock (RTC) device for Maxim DS1307 and similar
• FT5x06Touch - EDT FocalTech FT5x06 I2C touchscreen driver
• FTDISerial - FTDI USB to Serial converter driver
• GENET - Broadcom GENET gigabit ethernet driver
• GoodixTouch - Goodix I2C touchscreen driver
• HD44780 - LCD controller driver for Hitachi HD44780
• HIDKEYBOARD - Generic HID keyboard consumer
• HIDMOUSE - Generic HID mouse consumer
• HIDTOUCH - Generic HID touch consumer
• HIDJOYSTICK - Generic HID joystick consumer
• HX8357D - Framebuffer device driver for Himax HX8357D TFT LCD controller
• HyperPixel - Pimoroni HyperPixel TFT display driver
• I2CGPIO - GPIO based software I2C driver
• I2CLCD - Generic I2C LCD driver
• ILI9340 - Framebuffer device driver for ILITEK ILI9340 TFT LCD controller
• IPSTFT19 - Framebuffer device driver for Adafruit IPSTFT19 1.9" TFT LCD
• LAN78XX - USB Ethernet driver for Microchip LAN78XX
• MCP230XX - GPIO device driver for Microchip MCP230XX I/O expander
• PCF857X - NXP PCF857X I/O expander driver
• PiTFT28 - Framebuffer device driver for Adafruit PiTFT 2.8" LCD
• PiTFT35 - Framebuffer device driver for Adafruit PiTFT 3.5" LCD
• PL011 - ARM PrimeCell PL011 UART driver
• PL031 - ARM PrimeCell PL031 Real Time Clock driver
• PL050 - ARM PrimeCell PL050 PS2 Keyboard/Mouse Interface driver
• PL110 - ARM PrimeCell PL110 Color LCD Controller driver
• PL18X - ARM PrimeCell PL180/181 Multimedia Card Interface driver
• PL2303 - Prolific PL2303 USB to Serial converter driver
• RPIFT5406 - Touch device driver for Raspberry Pi FT5406
• RPIGPIOEXPANDER - Raspberry Pi firmware GPIO Expander driver
• RPISENSEHAT - Raspberry Pi Sense HAT driver
• RT2X00LIB - Ralink RT2x00 Wireless support library (Not yet completed)
• RT2X00USB - Ralink RT2x00 USB Wireless support library (Not yet completed)
• RT2800LIB - Ralink RT2800 Wireless support library (Not yet completed)
• RT2800USB - Ralink RT2800 USB Wireless driver (Not yet completed)
• RTL8188EU - Realtek 8188EU USB Wireless driver (Not yet completed)
• RTL8192CU - Realtek 8192CU USB Wireless driver (Not yet completed)
• RTLWIFI - Realtek 8xxx Wireless support library (Not yet completed)
• SMC91X - SMSC 91C9x/91C1xx Ethernet driver
• SMSC95XX - SMSC95XX USB network driver
• ST77XX - Framebuffer device driver for Sitronix ST77XX TFT LCD controller
• STMPE - GPIO and touch device driver for ST Microelectronics STMPE
• USBCDCACM - USB CDC (Communications Device Class) ACM driver
• USBCDCETHERNET - USB CDC (Communications Device Class) Ethernet driver
• USBKEYBOARD - Legacy USB Keyboard driver
• USBMOUSE - Legacy USB Mouse driver

Code page units

• CP1250ANSI - CP1250 ANSI Code page (Central Europe)
• CP1251ANSI - CP1251 ANSI Code page (Cyrillic)
• CP1253ANSI - CP1253 ANSI Code page (Greek)
• CP1254ANSI - CP1254 ANSI Code page (Turkish)
• CP1255ANSI - CP1255 ANSI Code page (Hebrew)
• CP1256ANSI - CP1256 ANSI Code page (Arabic)
• CP1257ANSI - CP1257 ANSI Code page (Baltic)
• CP1258ANSI - CP1258 ANSI Code page (Vietnam)
• CP874ANSI - CP874 ANSI Code page (Thai)
• CP720OEM - CP720 OEM Code page (Arabic)
• CP737OEM - CP737 OEM Code page (Greek)
• CP775OEM - CP775 OEM Code page (Baltic)
• CP850OEM - CP850 OEM Code page (Latin I)
• CP852OEM - CP852 OEM Code page (Latin II)
• CP857OEM - CP857 OEM Code page (Turkish)
• CP862OEM - CP862 OEM Code page (Hebrew)
• CP866OEM - CP866 OEM Code page (Russian)

Font units

• Default8x9 - Default 8x9 Console font
• Default8x16 - Default 8x16 Console font
• Latin1_8x8 - Latin-1 (8x8) Console font
• Latin1_8x10 - Latin-1 (8x10) Console font
• Latin1_8x12 - Latin-1 (8x12) Console font
• Latin1_8x14 - Latin-1 (8x14) Console font
• Sun_12x22 - Sun (12x22) Console font

Keymap units

• Keymap_DE - German (DE) Keyboard layout
• Keymap_ES - Spanish(ES) Keyboard layout
• Keymap_FR - French (FR) Keyboard layout
• Keymap_UK - UK English (UK) Keyboard layout
• Keymap_US - US English (US) Keyboard layout
• Keymap_US_Intl - US International (US-INTL) Keyboard layout

Extra units

• ConsoleShell - Console shell classes
• QEMUVersatilePB - QEMU VersatilePB include module
• RaspberryPi - Raspberry Pi (A, B, A+, B+, Zero) include module
• RaspberryPi2 - Raspberry Pi 2B include module
• RaspberryPi3 - Raspberry Pi 3B include module
• RaspberryPi4 - Raspberry Pi 4 include module
• RemoteShell - Remote shell (Telnet/SSH) classes
• ShellFilesystem - Filesystem shell commands
• ShellNetwork - Network shell commands
• ShellUpdate - HTTP update shell commands
• ShellUSB - USB shell extension unit
• WebStatus - HTTP status/information classes
• WiringI2C - WiringPiI2C API implementation
• WiringSerial - WiringPiSerial API implementation
• WiringSPI - WiringPiSPI API implementation

Boot units

• BootRPi - Raspberry Pi (A, B, A+, B+, Zero) boot module
• BootRPi2 - Raspberry Pi 2B boot module
• BootRPi3 - Raspberry Pi 3B boot module
• BootRPi4 - Raspberry Pi 4 boot module
• BootPCx86 - PC x86 boot module (Not yet implemented)
• BootPCx86_64 - PC x86_64 boot module (Not yet implemented)
• BootQEMUVPB - QEMU VersatilePB boot module

Platform units

• PlatformRPi - Raspberry Pi (A, B, A+, B+, Zero) platform module
• PlatformRPi2 - Raspberry Pi 2B platform module
• PlatformRPi3 - Raspberry Pi 3B platform module
• PlatformRPi4 - Raspberry Pi 4 platform module
• PlatformPC - PC platform module (Not yet implemented)
• PlatformQEMUVPB - QEMU VersatilePB platform module

Architecture units

• PlatformAARCH64 - AARCH64 (ARM64) processor module
• PlatformARM - ARM processor module
• PlatformARMv6 - ARMv6 processor module
• PlatformARMv7 - ARMv7 processor module
• PlatformARMv7L - ARMv7 LPAE processor module
• PlatformARMv8 - ARMv8 processor module
• Platformx86 - Intel x86 processor module (Not yet implemented)
• Platformx86_64 - Intel x86_64 processor module (Not yet implemented)
• PlatformMIPS - MIPS processor module (Not yet implemented)
• PlatformMIPS32 - MIPS32 processor module (Not yet implemented)

Ultibounits package

• DispmanX - Ultibo DispmanX interface unit
• EGL - Ultibo EGL interface unit
• OpenVG - Ultibo OpenVG interface unit
• uBitmap - Ultibo Bitmap utility unit
• uScreenshot - Ultibo Screenshot utility unit
• VGShapes - Ultibo VGShapes library unit