This commit is contained in:
Jeffrey Townsend
2018-12-29 09:11:15 -08:00
parent 1f77ec611f
commit 9cd9b4949f
8 changed files with 89 additions and 2 deletions

View File

@@ -27,4 +27,5 @@ It is possible to query the Chassis for any generic debug, internal state or sta
* [Doxygen](https://htmlpreview.github.io/?https://raw.githubusercontent.com/opencomputeproject/OpenNetworkLinux/ONLPv2/packages/base/any/onlp/src/onlp/doc/html/group__oid-chassis.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/chassis.h)
---
[Return to APIs](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications/apis)

View File

@@ -10,4 +10,5 @@ Fan features include things like direction, RPM, and speed percentage.
* [Doxygen](https://htmlpreview.github.io/?https://raw.githubusercontent.com/opencomputeproject/OpenNetworkLinux/ONLPv2/packages/base/any/onlp/src/onlp/doc/html/group__oid-fan.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/fan.h)
---
[Return to APIs](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications/apis)

View File

@@ -1 +1,18 @@
# Generics
## Generic OIDs
Generic OIDs are defined by the platform implementor. Their properties and usage are up the the platform implementor. They are custom cookie OIDs used to access platform-specific functionality which is not defined in the ONLP API itself.
## Generic Information Structure
The current status of a generic oid is queried using ```onlp_generic_info_get``` to populate the ```onlp_generic_info_t``` structure.
There are no fields defined in the information structure. Custom interaction with a Generic OID must be done through the OID Attribute APIs.
## Generic Documentation
* [Doxygen](https://htmlpreview.github.io/?https://raw.githubusercontent.com/opencomputeproject/OpenNetworkLinux/ONLPv2/packages/base/any/onlp/src/onlp/doc/html/group__oid-generic.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/generic.h)
---
[Return to APIs](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications/apis)

View File

@@ -1 +1,18 @@
# LEDs
## LED Information Structure
The current status of an LED is queried using ```onlp_led_info_get``` to populate the ```onlp_led_info_t``` structure.
LED features include things like available colors, blinking modes, and character display features.
## LED Specific APIs
You can change the current mode of the LED if supported.
## LED Documentation
* [Doxygen](https://htmlpreview.github.io/?https://raw.githubusercontent.com/opencomputeproject/OpenNetworkLinux/ONLPv2/packages/base/any/onlp/src/onlp/doc/html/group__oid-led.html.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h)
---
[Return to APIs](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications/apis)

View File

@@ -1 +1,21 @@
# Modules
## Module OIDs
Module OIDs represent containers for other OIDs, for example a hot-pluggable chassis module or line-card.
Module OIDs are similar to the Chassis OID as a container for dynamic children but are not restricted to a single instance, have dynamic status, and are defined by the platform.
## Module Information Structure
The current status of a module is queried using ```onlp_module_info_get``` to populate the ```onlp_module_info_t``` structure.
There are no module-specific fields in this structure as it is just a dynamic container for child OIDs. Those children can then be inspected and enumerated recursively.
## Module Documentation
* [Doxygen](https://htmlpreview.github.io/?https://raw.githubusercontent.com/opencomputeproject/OpenNetworkLinux/ONLPv2/packages/base/any/onlp/src/onlp/doc/html/group__oid-module.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/module.h)
---
[Return to APIs](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications/apis)

View File

@@ -1 +1,14 @@
# PSUs
## PSU Information Structure
The current status and capabilities of a PSU are queried using ```onlp_psu_info_get``` to populate the ```onlp_psu_info_t``` structure.
PSU features include things like voltage, power, current, and type (AC or DC).
## PSU Documentation
* [Doxygen](https://htmlpreview.github.io/?https://raw.githubusercontent.com/opencomputeproject/OpenNetworkLinux/ONLPv2/packages/base/any/onlp/src/onlp/doc/html/group__oid-psu.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/psu.h)
---
[Return to APIs](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications/apis)

View File

@@ -1 +1,14 @@
# Thermals
## Thermal Information Structure
The current status of a temperature sensors is queried using ```onlp_thermal_info_get``` to populate the ```onlp_thermal_info_t``` structure.
Thermal features include current temperature and any warning or shutdown thresholds for the given sensor.
## Thermal Documentation
* [Doxygen](https://htmlpreview.github.io/?https://raw.githubusercontent.com/opencomputeproject/OpenNetworkLinux/ONLPv2/packages/base/any/onlp/src/onlp/doc/html/thermal_8h.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/thermal.h)
---
[Return to APIs](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications/apis)

View File

@@ -7,8 +7,13 @@ The goal of the ONLP APIs is to both standardize access to these objects at a fu
## ONLP APIs for Applications
The ONLP API documentation for Application, System, and Dataplane developers is available [here](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications).
The ONLP API user documentation for Application, System, and Dataplane developers is available [here](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications).
## ONLP APIs for Platform Developers
The ONLP API documentation for Platform developers who which to implement support for their platform is available [here](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/implementors).
The ONLP API user documentation for Platform developers who which to implement support for their platform is available [here](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/implementors).
## ONLP API Reference
The ONLP Reference Documentation is maintained using Doxygen and can be browsed [here](https://htmlpreview.github.io/?https://raw.githubusercontent.com/opencomputeproject/OpenNetworkLinux/ONLPv2/packages/base/any/onlp/src/onlp/doc/html/index.html).