Skip to content

Document DeviceAPI Pattern - Value 5 #140

@LSantha

Description

@LSantha

Concept: DeviceAPI Pattern

Value: 5 (Critical - Device abstraction)

What it is: Interface-based API pattern for device access with separate API and implementation

Key files:

  • core/src/driver/org/jnode/driver/DeviceAPI.java
  • core/src/driver/org/jnode/driver/DeviceInfoAPI.java

Bridges: Device framework, Driver implementation, Hardware access


Documentation Requirements

For Value 5 (Critical):

  1. Update ALL 4 sections of the index (index.md):

    • Pages Table: Add new page in alphabetical order
    • Concepts → Pages: Add the page name. Currently "DeviceAPI" is mentioned in [[Device-Manager]]
    • Source Path → Pages: Map core/src/driver/org/jnode/driver/ to the new page
    • Task Routing: Add to relevant developer task categories with meaningful routing ideas (1-3 entries)
  2. Update Glossary: Add 1-sentence definition for any new project-specific term

  3. Broader Search: Search for related "Helper", "Manager", "Layout", or "Constants" classes (e.g., API implementations, device info)

Skill Reference

Use update-wiki skill for wiki maintenance workflow


Related Concepts (from index.md)

  • [[Device-Manager]]
  • [[Driver-Framework]]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions