Skip to content

Commit

Permalink
DOCS-1488: Add generic component to micro-RDK (#2296)
Browse files Browse the repository at this point in the history
  • Loading branch information
sguequierre authored Dec 7, 2023
1 parent d2ae68c commit a948529
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/build/micro-rdk/base/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ The micro-RDK [base API](/components/base/#api) is limited to the following supp

- [`Stop()`](/components/base/#stop)
- [`SetPower()`](/components/base/#setpower)
- [`DoCommand()`](/components/base/#docommand)
1 change: 1 addition & 0 deletions docs/build/micro-rdk/board/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ For configuration information, click on the supported board model name:
The micro-RDK [board API](/components/board/#api) supports only the following client SDK API methods, which operate the same as in the full-featured RDK:

- [`SetPowerMode()`](/components/board/#setpowermode)
- [`DoCommand()`](/components/board/#docommand)

For `GPIOPin`s:

Expand Down
1 change: 1 addition & 0 deletions docs/build/micro-rdk/encoder/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ The micro-RDK [encoder API](/components/encoder/#api) supports only the followin
- [`ResetPosition()`](/components/encoder/#resetposition)
- [`GetPosition()`](/components/encoder/#getposition)
- [`GetProperties()`](/components/encoder/#getproperties)
- [`DoCommand()`](/components/encoder/#docommand)
28 changes: 28 additions & 0 deletions docs/build/micro-rdk/generic/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Micro-RDK Generic Models"
linkTitle: "Generic"
weight: 30
type: "docs"
description: "Support in the micro-RDK for generic compoent types."
images: ["/icons/components/generic.svg"]
tags: ["generic", "components", "micro-rdk"]
no_list: true
# SMEs: Gautham V.
---

The _generic_ component {{< glossary_tooltip term_id="subtype" text="subtype" >}} enables you to add support for unique types of hardware that do not already have an [appropriate API](/build/program/apis/#component-apis) defined for them.
For more information and models supported by the {{< glossary_tooltip term_id="rdk" text="RDK" >}}, see [Generic Component](/components/generic/).

<!--
## Supported Models
For configuration information, click on the supported generic model name:
Model | Description
----- | -----------
[`fake`](fake/) | A model used for testing, with no physical hardware. -->

## API

The micro-RDK [generic API](/components/generic/#api) supports only the following client SDK API methods, which operate the same as in the full-featured RDK:

- [`DoCommand()`](/components/generic/#docommand)
1 change: 1 addition & 0 deletions docs/build/micro-rdk/movement-sensor/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,4 @@ The micro-RDK [movement sensor API](/components/movement-sensor/#api) supports o
- [`GetPosition()`](/components/movement-sensor/#getposition)
- [`GetProperties()`](/components/movement-sensor/#getproperties)
- [`GetLinearAcceleration()`](/components/movement-sensor/#getlinearacceleration)
- [`DoCommand()`](/components/movement-sensor/#docommand)
1 change: 1 addition & 0 deletions docs/build/micro-rdk/servo/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,4 @@ The micro-RDK [servo API](/components/servo/#api) supports the following client
- [`Move()`](/components/servo/#move)
- [`GetPosition()`](/components/servo/#getposition)
- [`Stop()`](/components/servo/#stop)
- [`DoCommand()`](/components/servo/#docommand)
1 change: 1 addition & 0 deletions static/include/micro-rdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The only microcontroller the micro-RDK currently supports is the [ESP32](https:/
- [Movement Sensor](/build/micro-rdk/movement-sensor/)
- [Motor](/build/micro-rdk/motor/)
- [Servo](/build/micro-rdk/servo/)
- [Generic](/build/micro-rdk/generic/)

Click on each supported resource to see supported models, API methods, and configuration info.

Expand Down

0 comments on commit a948529

Please sign in to comment.