README

dept-of-scrapyard-robotics/fd — file descriptor module for the ScrapyardIO Framework.

Provides a lightweight PHP layer over the ext-fd extension. It exposes simple helper functions for opening, closing, reading, and writing raw file descriptors, plus reusable traits, attributes, and enums for higher-level ScrapyardIO packages.

Requirements

• PHP ^8.3
• ext-fd 0.1.0 (Zephir extension — see DeptOfScrapyardRobotics/FD for build & install instructions)
• dept-of-scrapyard-robotics/support ^0.3.0
• A UNIX-like environment supported by ext-fd

Installation

composer require dept-of-scrapyard-robotics/fd

Quick Start

Opening and closing a device

use ScrapyardIO\FD\Enums\FileControlFlag;

$fd = fd_open('/dev/i2c-1', FileControlFlag::O_RDWR->value);

if ($fd < 0) {
    throw new RuntimeException('Unable to open device');
}

$bytes = fd_read($fd, 2);

fd_close($fd);

Writing to a descriptor

use ScrapyardIO\FD\Enums\FileControlFlag;

$fd = fd_open('/dev/ttyUSB0', FileControlFlag::O_WRONLY->value);

fd_write($fd, "\x3A", 1);
fd_close($fd);

API Reference

Helper Functions

Autoloaded global helper functions that forward directly to the ext-fd extension.

FileControlFlag

Enum of common fcntl.h/POSIX open flags.

FileDescriptors

Reusable trait for ScrapyardIO classes that open their descriptor from annotated properties.

use ScrapyardIO\FD\Attributes\FDFlags;
use ScrapyardIO\FD\Attributes\FilePath;
use ScrapyardIO\FD\Concerns\FileDescriptors;
use ScrapyardIO\FD\Enums\FileControlFlag;

class Device
{
    use FileDescriptors;

    #[FilePath]
    public readonly string $devicePath;

    #[FDFlags]
    public readonly int $flags;

    public function __construct()
    {
        $this->devicePath = '/dev/i2c-1';
        $this->flags = FileControlFlag::O_RDWR->value;

        $fd = $this->fOpen();
    }
}

Attributes

Marker attributes used by FileDescriptors.

License

MIT — © Angel Gonzalez / Project Saturn Studios