Difference between revisions of "Unit Reference"
From Ultibo.org
| Line 69: | Line 69: | ||
* [[Unit_Keymap|Keymap]] - Keymap manager | * [[Unit_Keymap|Keymap]] - Keymap manager | ||
* [[Unit_MPEG|MPEG]] - MPEG encoding/decoding support module (Not yet implemented) | * [[Unit_MPEG|MPEG]] - MPEG encoding/decoding support module (Not yet implemented) | ||
| + | * [[Unit_Security|Security]] - Security descriptor support module | ||
| + | * [[Unit_Shell|Shell]] - Shell manager | ||
| + | * [[Unit_SSL|SSL]] - SSL/TLS support module (Not yet implemented) | ||
| + | * [[Unit_Timezone|Timezone]] - Timezone manager | ||
| + | * [[Unit_Ultibo|Ultibo]] - Ultibo API / Windows compatibility | ||
| + | * [[Unit_UltiboClasses|UltiboClasses]] - Ultibo API classes | ||
| + | * [[Unit_UltiboUtils|UltiboUtils]] - Ultibo API utilities | ||
| + | * [[Unit_VPN|VPN]] - VPN support module (Not yet implemented) | ||
| + | * [[Unit_Wiring|Wiring]] - Wiring API implementation (Not yet implemented) | ||
=== Device units === | === Device units === | ||
| Line 90: | Line 99: | ||
* [[Unit_Keyboard|Keyboard]] - Keyboard device interface / USB keyboard driver | * [[Unit_Keyboard|Keyboard]] - Keyboard device interface / USB keyboard driver | ||
* [[Unit_Logging|Logging]] - Logging device interface | * [[Unit_Logging|Logging]] - Logging device interface | ||
| − | * [[Unit_MMC|MMC]] - MMC/SD device interface | + | * [[Unit_MMC|MMC]] - MMC/SD device/host interface |
| − | * [[Unit_MMCSPI|MMCSPI]] - MMC SPI | + | * [[Unit_MMCSPI|MMCSPI]] - MMC SPI interface module (Not yet implemented) |
* [[Unit_Mouse|Mouse]] - Mouse device interface / USB mouse driver | * [[Unit_Mouse|Mouse]] - Mouse device interface / USB mouse driver | ||
| + | * [[Unit_PWM|PWM]] - PWM device interface (Not yet implemented) | ||
| + | * [[Unit_SCSI|SCSI]] - SCSI device interface | ||
| + | * [[Unit_Serial|Serial]] - Serial device interface (Not yet implemented) | ||
| + | * [[Unit_SPI|SPI]] - SPI device interface (Not yet implemented) | ||
| + | * [[Unit_Storage|Storage]] - Storage device interface / USB storage driver | ||
| + | * [[Unit_USB|USB]] - USB device/driver/host interface | ||
| + | * [[Unit_Video|Video]] - Video device interface / USB video driver (Not yet implemented) | ||
=== Hardware units === | === Hardware units === | ||
| Line 110: | Line 126: | ||
* [[Unit_Mali400|Mali400]] - ARM Mali400 GPU driver module (Not yet implemented) | * [[Unit_Mali400|Mali400]] - ARM Mali400 GPU driver module (Not yet implemented) | ||
* [[Unit_Mali450|Mali450]] - ARM Mali450 GPU driver module (Not yet implemented) | * [[Unit_Mali450|Mali450]] - ARM Mali450 GPU driver module (Not yet implemented) | ||
| + | * [[Unit_SMSC95XX|SMSC95XX]] - SCSM95XX USB network driver | ||
| + | * [[Unit_VC4|VC4]] - VideoCore4 GPU driver module (Not yet implemented) | ||
| + | * [[Unit_XHCI|XHCI]] - USB XHCI host controller module (Not yet implemented) | ||
=== Network units === | === Network units === | ||
| Line 128: | Line 147: | ||
* [[Unit_IPv6|IPv6]] - IPv6 transport module | * [[Unit_IPv6|IPv6]] - IPv6 transport module | ||
* [[Unit_Loopback|Loopback]] - Loopback adapter module | * [[Unit_Loopback|Loopback]] - Loopback adapter module | ||
| − | * [[Unit_Network|Network]] - Network device interface / Network manager | + | * [[Unit_Network|Network]] - Network device interface / Adapter manager |
| + | * [[Unit_POP3|POP3]] - POP3 client and server classes | ||
| + | * [[Unit_Protocol|Protocol]] - Protocol manager | ||
| + | * [[Unit_RAW|RAW]] - RAW protocol module | ||
| + | * [[Unit_Services|Services]] - Network services (NTP/SysLog/Telnet) classes | ||
| + | * [[Unit_SIP|SIP]] - SIP client and server classes (Not yet implemented) | ||
| + | * [[Unit_SMTP|SMTP]] - SMTP client and server classes | ||
| + | * [[Unit_Sockets|Sockets]] - Sockets interface | ||
| + | * [[Unit_TCP|TCP]] - TCP protocol module | ||
| + | * [[Unit_Transport|Transport]] - Transport manager | ||
| + | * [[Unit_UDP|UDP]] - UDP protocol module | ||
| + | * [[Unit_WiFi|WiFi]] - WiFi (WPA) transport module (Not yet implemented) | ||
| + | * [[Unit_Winsock|Winsock]] - Winsock 1.1 interface | ||
| + | * [[Unit_Winsock2|Winsock2]] - Winsock 2.0 interface | ||
| + | * [[Unit_XMPP|XMPP]] - XMPP client and server classes (Not yet implemented) | ||
=== Filesystem units === | === Filesystem units === | ||
| Line 144: | Line 177: | ||
* [[Unit_NTFSTypes|NTFSTypes]] - NTFS type definitions | * [[Unit_NTFSTypes|NTFSTypes]] - NTFS type definitions | ||
* [[Unit_NTFSUtils|NTFSUtils]] - NTFS utility functions | * [[Unit_NTFSUtils|NTFSUtils]] - NTFS utility functions | ||
| + | * [[Unit_VirtualDisk|VirtualDisk]] - Virtual disk filesystem module | ||
=== Extra units === | === Extra units === | ||
---- | ---- | ||
| + | |||
| + | * [[Unit_ConsoleShell|ConsoleShell]] - Console shell classes | ||
| + | * [[Unit_RaspberryPi|RaspberryPi]] - Raspberry Pi (A, B, A+, B+, Zero) include module | ||
| + | * [[Unit_RaspberryPi2|RaspberryPi2]] - Raspberry Pi 2B include module | ||
| + | * [[Unit_RemoteShell|RemoteShell]] - Remote shell (Telnet/SSH) classes | ||
| + | * [[Unit_ShellFilesystem|ShellFilesystem]] - Filesystem shell commands | ||
| + | * [[Unit_ShellUpdate|ShellUpdate]] - HTTP update shell commands | ||
| + | * [[Unit_WebStatus|WebStatus]] - HTTP status/information classes | ||
Revision as of 23:41, 27 January 2016
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 it's function and usage.
Contents
Boot units
- BootRPi - Raspberry Pi (A, B, A+, B+, Zero) boot module
- BootRPi2 - Raspberry Pi 2B boot module
- BootBBB - BeagleBone Black boot module (Not yet implemented)
- BootBPi - Banana Pi boot module (Not yet implemented)
- BootBPro - Banana Pro boot module (Not yet implemented)
- BootCI20 - MIPS Creator CI20 boot module (Not yet implemented)
- BootCuboxi - Cubox i2/i4 boot module (Not yet implemented)
- BootOdroidC1 - Odroid C1 boot module (Not yet implemented)
- BootOdroidU3 - Odroid U3 boot module (Not yet implemented)
- BootOdroidXU3 - Odroid XU3 boot module (Not yet implemented)
- BootpcDuino - pcDuino boot module (Not yet implemented)
- BootPCx86 - PC x86 boot module (Not yet implemented)
- BootPCx86_64 - PC x86_64 boot module (Not yet implemented)
Platform units
- PlatformRPi - Raspberry Pi (A, B, A+, B+, Zero) platform module
- PlatformRPi2 - Raspberry Pi 2B platform module
- PlatformBBB - BeagleBone Black platform module (Not yet implemented)
- PlatformBPi - Banana Pi platform module (Not yet implemented)
- PlatformBPro - Banana Pro platform module (Not yet implemented)
- PlatformCI20 - MIPS Creator CI20 platform module (Not yet implemented)
- PlatformCuboxi - Cubox i2/i4 platform module (Not yet implemented)
- PlatformOdroidC1 - Odroid C1 platform module (Not yet implemented)
- PlatformOdroidU3 - Odroid U3 platform module (Not yet implemented)
- PlatformOdroidXU3 - Odroid XU3 platform module (Not yet implemented)
- PlatformpcDuino - pcDuino platform module (Not yet implemented)
- PlatformPC - PC platform module (Not yet implemented)
Architecture units
- PlatformARM - ARM processor module
- PlatformARMv6 - ARMv6 processor module
- PlatformARMv7 - ARMv7 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)
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
- Authentication - Authentication base classes
- Crypto - Cryptography support module (Not yet implemented)
- 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)
- Timezone - Timezone manager
- Ultibo - Ultibo API / Windows compatibility
- UltiboClasses - Ultibo API classes
- UltiboUtils - Ultibo API utilities
- VPN - VPN support module (Not yet implemented)
- Wiring - Wiring API implementation (Not yet implemented)
Device units
- AHCI - Advanced Host Controller Interface (AHCI) (Not yet implemented)
- 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)
- Console - Console device interface
- DAB - Digital Audio Broadcast (DAB) device interface (Not yet implemented)
- 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
- GPIO - GPIO device interface (Not yet implemented)
- I2C - I2C device interface (Not yet implemented)
- I2S - I2S device interface (Not yet implemented)
- iSCSI - iSCSI device interface (Not yet implemented)
- Keyboard - Keyboard device interface / USB keyboard driver
- Logging - Logging device interface
- MMC - MMC/SD device/host interface
- MMCSPI - MMC SPI interface module (Not yet implemented)
- Mouse - Mouse device interface / USB mouse driver
- PWM - PWM device interface (Not yet implemented)
- SCSI - SCSI device interface
- Serial - Serial device interface (Not yet implemented)
- SPI - SPI device interface (Not yet implemented)
- Storage - Storage device interface / USB storage driver
- USB - USB device/driver/host interface
- Video - Video device interface / USB video driver (Not yet implemented)
Hardware units
- AllwinnerA20 - Allwinner A20 SoC support module (Not yet implemented)
- AllwinnerH3 - Allwinner A20 SoC support module (Not yet implemented)
- BCM2708 - Broadcom BCM2835 SoC driver module
- BCM2709 - Broadcom BCM2836 SoC driver module
- BCM2835 - Broadcom BCM2835 SoC support module
- BCM2836 - Broadcom BCM2836 SoC support module
- DWCOTG - Synopsis Designware USB host controller module
- EHCI - USB EHCI host controller module (Not yet implemented)
- FreescaleiMX6 - Freescale iMX6 SoC support module (Not yet implemented)
- GC880 - GC880 GPU driver module (Not yet implemented)
- GC2000 - GC2000 GPU driver module (Not yet implemented)
- Mali400 - ARM Mali400 GPU driver module (Not yet implemented)
- Mali450 - ARM Mali450 GPU driver module (Not yet implemented)
- SMSC95XX - SCSM95XX USB network driver
- VC4 - VideoCore4 GPU driver module (Not yet implemented)
- 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
- IGMP - IGMP protocol module
- IMAP4 - IMAP4 client and server classes
- IP - IPv4 transport module
- IPHlpAPI - IP Helper API
- IPv6 - IPv6 transport module
- 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
Extra units
- ConsoleShell - Console shell classes
- RaspberryPi - Raspberry Pi (A, B, A+, B+, Zero) include module
- RaspberryPi2 - Raspberry Pi 2B include module
- RemoteShell - Remote shell (Telnet/SSH) classes
- ShellFilesystem - Filesystem shell commands
- ShellUpdate - HTTP update shell commands
- WebStatus - HTTP status/information classes
