maix::peripheral::pinmap
maix.peripheral.pinmap module
This is
maix::peripheral::pinmapmodule of MaixCDK.
All of these elements are in namespacemaix::peripheral::pinmap.For MaixCDK developer: DO NOT edit this doc file manually, this doc is auto generated!
Module
No module
Enum
Variable
Function
get_pins
Get all pins of devices
| item | description |
|---|---|
| return | pin name list, string type. |
C++ defination code:
std::vector<std::string> get_pins()
get_pin_functions
Get all function of a pin
| item | description |
|---|---|
| param | pin: pin name, string type. |
| return | function list, function name is string type. |
| throw | If pin name error will throwout err.Err.ERR_ARGS error. |
C++ defination code:
std::vector<std::string> get_pin_functions(const std::string &pin)
set_pin_function
Set function of a pin
| item | description |
|---|---|
| param | pin: pin name, string type. func: which function should this pin use. |
| return | if set ok, will return err.Err.ERR_NONE, else error occurs. |
C++ defination code:
err::Err set_pin_function(const std::string &pin, const std::string &func)
get_pin_function
Get pin's current function
| item | description |
|---|---|
| param | pin: pin name, string type. |
| return | pin's current funtion name. |
| throw | If pin name error will throwout err.Err.ERR_ARGS error, if not implement for this pin, or read/write register failed, will throwout err.Err.Exception. |
C++ defination code:
std::string get_pin_function(const std::string &pin)
