Documentation
Learn how to use OpenEmbedWorks, discover tools, and contribute to the community.
Getting Started
OpenEmbedWorks is a curated catalog of browser-native engineering tools for systems programmers, embedded engineers, and networking professionals. All tools run directly in your browserβno installation required.
First Time?
- Visit the Tools catalog
- Browse by Categories (Systems, Embedded, Networking, Development)
- Refine results with Tags (e.g., Binary Analysis, Automotive, Scheduling)
- Search for specific tool names or keywords
- Click Open to launch any tool in your browser
Each tool includes a description, rating, GitHub repository link (if available), and links to subcategories for quick discovery.
Features
π Advanced Search
Search by tool name, tags, or description. Results update instantly as you type.
π Sortable Table
Click column headers to sort by Tool name, Category, Rating, or GitHub stars. Toggle ascending/descending by clicking again.
π·οΈ Tag Filtering
Select one or multiple tags (e.g., Automotive, RTOS, Scheduling) to refine the catalog.
β Ratings & Stars
Tools are rated 1β5 stars. GitHub star counts are fetched and cached to reflect community adoption.
π¨ View Modes
Toggle between Table (compact, sortable rows) and Tile (visual card grid) views.
π URL State Persistence
Filters, search, sort, and view mode are saved in the URL. Share filtered views with colleagues.
Search & Filter Guide
By Category
Top-level categories group tools by engineering domain. Select any category button to filter. Categories are:
- Systems and Linux β ELF inspection, hex editing, memory mapping
- Embedded and Automotive β CAN, UDS, AUTOSAR, RTOS scheduling
- Networking and Protocols β gPTP time sync, packet capture analysis
- Development Tools β Compilers, productivity utilities
By Tags (Subcategories)
Tags provide fine-grained discovery within a category. Each tool may have multiple tags. Select any tag to filter results within the current category.
Search Box
Type any keyword to search across tool names, descriptions, and tags. Search is case-insensitive and matches partial words. Results update live.
Sort Options
In Table view, click any column header to sort:
- Tool β Alphabetical by tool name
- Rating β User rating (high to low, or vice versa)
- GitHub stars β Community adoption metric
Click the same header again to reverse the sort direction. The active sort column is highlighted in blue.
Clear Filters
The "Clear filters" button next to the search box resets all selections and returns to the full catalog.
Offline Usage
How It Works
OpenEmbedWorks uses a Service Worker to cache the catalog on your first visit. After that, the entire site works offlineβno internet required.
Requirements
- Browser must support Service Workers (all modern browsers do)
- Site must be served over
https://orlocalhost - First load must be online to cache assets
What's Cached
- HTML, CSS, and JavaScript
- Complete tool catalog (tools-data.js)
- SEO metadata and assets
What's Not Cached
- GitHub star counts (fetched only when online; falls back to seed values)
- External tool links (you can still click them; they open if online)
Cache Updates
When new versions are deployed, the Service Worker automatically clears the old cache and pre-caches the new version on your next visit.
Tools Architecture
Most OpenEmbedWorks tools share a common browser-native architecture pattern: they run entirely on the client, process user data locally, and provide interactive visual analysis without requiring server-side compute.
Generic Tool Architecture Layers
- Input layer β File upload, JSON paste, form inputs, or scenario parameters entered directly by the user.
- Parser and validation layer β Format-aware parsers decode inputs and validate structure, ranges, and constraints.
- Core analysis and simulation layer β Tool-specific algorithms run in-memory (decode, transform, simulate, measure, or compare).
- Visualization layer β Tables, timelines, charts, and contextual inspectors render intermediate and final results.
- Export layer β Users can copy results, download generated artifacts, or save transformed outputs.
- Offline and caching layer β Static assets are cached so the tool remains usable in low-connectivity environments.
Typical Runtime Flow
- Load tool shell (HTML/CSS/JS) and initialize default state.
- Accept user input (file, text payload, parameters, or presets).
- Parse and validate input; surface actionable validation errors when needed.
- Run tool logic (analysis pipeline or simulation engine) in-memory.
- Render synchronized visual outputs and derived metrics.
- Allow iterative adjustments and instant recomputation.
- Export or share output artifacts where supported.
Capabilities This Architecture Enables
- Low-latency interaction β Immediate feedback while tuning filters, parameters, offsets, or simulation settings.
- Deterministic behavior β Reproducible analysis from the same input and configuration.
- Deep introspection β Drill into raw structures, decoded fields, and timeline details.
- What-if simulation β Evaluate alternative conditions without changing production systems.
- Portable workflows β Run in any modern browser without installing native dependencies.
Reference Examples
- Hex Lens β Input: binary buffers. Core: byte-level parse and edit operations. Visualization: structured hex/ASCII views and diffs. Output: modified binary export.
- gPTP / STBM Time Synchronization Visualizer β Input: sync parameters or packet-derived timing data. Core: time-sync calculation and offset/drift analysis. Visualization: time alignment and synchronization behavior across nodes.
- ChronoLens (RTOS Scheduling and Timing Analyzer) β Input: task periods, priorities, offsets, ISR events. Core: scheduling simulation with preemption and latency accounting. Visualization: execution timeline, deadline behavior, and timing metrics.
Security and Privacy Model
The default model is local processing in the browser: user inputs are parsed and analyzed client-side, which minimizes data exposure and supports security-sensitive engineering workflows. Network calls are optional and generally limited to static asset delivery or non-critical metadata.
Tool Data Schema
All tool information is stored in tools-data.js, a small script that assigns
a structured JSON object to window.OEW_TOOLS_DATA. Loading it as a script
(rather than fetching JSON) means the catalog works the same whether the site is opened
over https:// or directly from disk (file://). If you're
contributing or integrating OpenEmbedWorks, here's the schema (v1.0):
Field Reference
- id β Unique identifier (lowercase, hyphens)
- name β Display name
- category β Must reference a category id
- tags β Array of tag ids
- description β 1β2 sentence summary
- url β Direct link to tool or demo
- githubRepo β Optional: "owner/repo" for star metrics
- rating β {"value": 0β5, "count": number of ratings}
Contributing Tools
OpenEmbedWorks is a community-driven project. We welcome contributions from engineers who have built tools for the embedded, systems, and networking communities.
How to Add a Tool
-
Fork the repository
github.com/openembedworks/openembedworks.github.io -
Edit tools-data.js
Add your tool entry using the schema above (inside thewindow.OEW_TOOLS_DATAobject). Ensure all required fields are populated. -
Validate your changes
Ensure the JSON object assigned towindow.OEW_TOOLS_DATAis valid (no syntax errors). Test locally if possible. -
Submit a Pull Request
Include a description of your tool and why it belongs in OpenEmbedWorks. Link to the tool repository if available. -
Review & merge
Maintainers will review and merge your PR. The catalog updates automatically.
Contribution Guidelines
- Tool must run in a browser (no native app installation)
- Works online and offline β or at least functions fully without network for core features
- Open source β Preferred, but not strictly required
- Clear description β 1β2 sentences summarizing the tool's purpose
- Accurate category & tags β Must match existing taxonomy or propose new ones
- Active maintenance β We favor tools that are actively developed or maintained
Questions?
Open an issue in the GitHub repository or reach out to the community.
Frequently Asked Questions
Q: Do tools require any installation?
A: No. All tools are web-based and run directly in your browser. No downloads, installs, or dependencies.
Q: Can I use tools offline?
A: Yes, once you've visited OpenEmbedWorks online, the catalog and tools are cached. You can then access them offline.
Q: Is my data private?
A: All processing happens client-side in your browser. No data is sent to servers unless a specific tool requires it. See the tool's documentation for privacy details.
Q: Can I contribute a tool I built?
A: Yes! See the Contributing Tools section above. We'd love to have your tool in the catalog.
Q: How do I report a bug or request a feature?
A: Open an issue on GitHub. Please provide as much detail as possible.
Q: Can I fork or modify OpenEmbedWorks?
A: Yes. OpenEmbedWorks is open source. Check the repository for the license and guidelines.
Q: How are tools rated?
A: Ratings are contributed by the community. Higher ratings indicate tools that engineers find useful and reliable. GitHub star counts are also shown as a secondary adoption metric.
Have more questions? Start a discussion on GitHub or open an issue.