Skip to content

Commit c1f3f76

Browse files
committed
Added initial API documentation for sensors and timers
1 parent 2a80661 commit c1f3f76

4 files changed

Lines changed: 822 additions & 4 deletions

File tree

_config.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@ logo: "/assets/images/logo.png"
1515
enable_copy_code_button: true
1616
permalink: pretty
1717

18-
# Heading anchors/TOC
18+
# TOC
19+
toc_enabled: true
20+
toc:
21+
min_level: 2 # Start with h2 (##)
22+
max_level: 4 # End with h4 (####)
1923
heading_anchors: true
20-
toc: true
2124

2225
### Defaults paths/content types
2326
defaults:

docs/reference/container-api/index.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,25 @@
22
title: Container APIs
33
layout: default
44
parent: Reference
5+
has_toc: false
56
---
67

7-
88
# Container APIs
99

10-
This section documents the Ocre Container APIs.
10+
Container APIs provide direct interfaces for containers to efficiently interact with underlying system resources and capabilities. Designed with simplicity, security, and consistency in mind, these APIs follow well-defined patterns to facilitate ease of use and seamless integration.
11+
12+
These APIs serve as the foundation for container interactions, enabling capabilities such as:
13+
14+
- **Hardware Resource Access:** Interface with sensors to collect environmental or motion data.
15+
- **Timers:** Create and manage timed events with precise millisecond accuracy.
16+
- **WebAssembly Integration:** Ensure smooth execution within a WebAssembly-based environment, abstracting the complexity from container applications.
17+
18+
---
19+
20+
## Available APIs
21+
22+
Below are the core APIs available for Ocre containers. They are categorized for your convenience, with detailed documentation for each, including usage examples, error handling patterns, and best practices.
23+
24+
### System Interaction
25+
- [Sensors](sensors): Interface with hardware sensors for environmental and motion data
26+
- [Timers](timers): Create and manage timed events with millisecond precision

0 commit comments

Comments
 (0)