2024-12-06 04:09:30 +00:00
\doxysection { bno08x\+ \_ \+ config\+ \_ \+ t Struct Reference}
\hypertarget { structbno08x_ _ config_ _ t} { } \label { structbno08x_ _ config_ _ t} \index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
IMU configuration settings passed into constructor.
{ \ttfamily \# include $ < $ BNO08x\+ Global\+ Types.\+ hpp$ > $ }
\doxysubsubsection * { Public Member Functions}
\begin { DoxyCompactItemize}
\item
\mbox { \hyperlink { structbno08x_ _ config_ _ t_ a68e051212415a62e64c23678e7b40552} { bno08x\+ \_ \+ config\+ \_ \+ t} } (bool \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a0f629aaef6756aa80fec96b34476c627} { install\+ \_ \+ isr\+ \_ \+ service} } =true)
\begin { DoxyCompactList} \small \item \em Default IMU configuration settings constructor. To modify default GPIO pins, run "{ } idf.\+ py menuconfig"{ } esp32\+ \_ \+ \+ BNO08x-\/ \texorpdfstring { $ > $ } { >} GPIO Configuration. Alternatively, edit the default values in "{ } \+ Kconfig.\+ projbuild"{ } . \end { DoxyCompactList} \item
\mbox { \hyperlink { structbno08x_ _ config_ _ t_ afa37d6ffc6f4fc7c9aa7484d49458a4a} { bno08x\+ \_ \+ config\+ \_ \+ t} } (spi\+ \_ \+ host\+ \_ \+ device\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a020d2343750bb7debc2a108ae038c9ec} { spi\+ \_ \+ peripheral} } , gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a79023fd80039e41a22b7f73ccd5fc861} { io\+ \_ \+ mosi} } , gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a9468180a773892977db39cc5ed9368e3} { io\+ \_ \+ miso} } , gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a639685b91ae3198909d722316495246a} { io\+ \_ \+ sclk} } , gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ ab1b5351b63da0c172c942463d0dc2505} { io\+ \_ \+ cs} } , gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a3cfe965659cfbc6b0c5269bd0211975f} { io\+ \_ \+ int} } , gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a62745c761219139f66ecd173b51577fc} { io\+ \_ \+ rst} } , uint32\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a231614c3b20888360def2ce9db83f52a} { sclk\+ \_ \+ speed} } , bool \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a0f629aaef6756aa80fec96b34476c627} { install\+ \_ \+ isr\+ \_ \+ service} } =true)
\begin { DoxyCompactList} \small \item \em Overloaded IMU configuration settings constructor for custom pin settings. \end { DoxyCompactList} \end { DoxyCompactItemize}
\doxysubsubsection * { Public Attributes}
\begin { DoxyCompactItemize}
\item
spi\+ \_ \+ host\+ \_ \+ device\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a020d2343750bb7debc2a108ae038c9ec} { spi\+ \_ \+ peripheral} }
\begin { DoxyCompactList} \small \item \em SPI peripheral to be used. \end { DoxyCompactList} \item
gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a79023fd80039e41a22b7f73ccd5fc861} { io\+ \_ \+ mosi} }
\begin { DoxyCompactList} \small \item \em MOSI GPIO pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} DI pin) \end { DoxyCompactList} \item
gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a9468180a773892977db39cc5ed9368e3} { io\+ \_ \+ miso} }
\begin { DoxyCompactList} \small \item \em MISO GPIO pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} SDA pin) \end { DoxyCompactList} \item
gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a639685b91ae3198909d722316495246a} { io\+ \_ \+ sclk} }
\begin { DoxyCompactList} \small \item \em SCLK pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} SCL pin) \end { DoxyCompactList} \item
gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ ab1b5351b63da0c172c942463d0dc2505} { io\+ \_ \+ cs} }
\item
gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a3cfe965659cfbc6b0c5269bd0211975f} { io\+ \_ \+ int} }
\begin { DoxyCompactList} \small \item \em Chip select pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} CS pin) \end { DoxyCompactList} \item
gpio\+ \_ \+ num\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a62745c761219139f66ecd173b51577fc} { io\+ \_ \+ rst} }
\begin { DoxyCompactList} \small \item \em Host interrupt pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} INT pin) \end { DoxyCompactList} \item
uint32\+ \_ \+ t \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a231614c3b20888360def2ce9db83f52a} { sclk\+ \_ \+ speed} }
\begin { DoxyCompactList} \small \item \em Reset pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} RST pin) \end { DoxyCompactList} \item
bool \mbox { \hyperlink { structbno08x_ _ config_ _ t_ a0f629aaef6756aa80fec96b34476c627} { install\+ \_ \+ isr\+ \_ \+ service} }
\begin { DoxyCompactList} \small \item \em Indicates whether the ISR service for the HINT should be installed at IMU initialization, (if gpio\+ \_ \+ install\+ \_ \+ isr\+ \_ \+ service() is called before initialize() set this to false) \end { DoxyCompactList} \end { DoxyCompactItemize}
\doxysubsection { Detailed Description}
IMU configuration settings passed into constructor.
\doxysubsection { Constructor \& Destructor Documentation}
\Hypertarget { structbno08x_ _ config_ _ t_ a68e051212415a62e64c23678e7b40552} \label { structbno08x_ _ config_ _ t_ a68e051212415a62e64c23678e7b40552}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { bno08x\_ config\_ t()} { bno08x\_ config\_ t()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/2]} }
{ \footnotesize \ttfamily bno08x\+ \_ \+ config\+ \_ \+ t\+ ::bno08x\+ \_ \+ config\+ \_ \+ t (\begin { DoxyParamCaption} \item [{bool}] { install\+ \_ \+ isr\+ \_ \+ service = { \ttfamily true} } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [inline]} }
Default IMU configuration settings constructor. To modify default GPIO pins, run "{ } idf.\+ py menuconfig"{ } esp32\+ \_ \+ \+ BNO08x-\/ \texorpdfstring { $ > $ } { >} GPIO Configuration. Alternatively, edit the default values in "{ } \+ Kconfig.\+ projbuild"{ } .
\Hypertarget { structbno08x_ _ config_ _ t_ afa37d6ffc6f4fc7c9aa7484d49458a4a} \label { structbno08x_ _ config_ _ t_ afa37d6ffc6f4fc7c9aa7484d49458a4a}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { bno08x\_ config\_ t()} { bno08x\_ config\_ t()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/2]} }
{ \footnotesize \ttfamily bno08x\+ \_ \+ config\+ \_ \+ t\+ ::bno08x\+ \_ \+ config\+ \_ \+ t (\begin { DoxyParamCaption} \item [{spi\+\_\+host\+\_\+device\+\_\+t}] { spi\+ \_ \+ peripheral, } \item [{gpio\+\_\+num\+\_\+t}] { io\+ \_ \+ mosi, } \item [{gpio\+\_\+num\+\_\+t}] { io\+ \_ \+ miso, } \item [{gpio\+\_\+num\+\_\+t}] { io\+ \_ \+ sclk, } \item [{gpio\+\_\+num\+\_\+t}] { io\+ \_ \+ cs, } \item [{gpio\+\_\+num\+\_\+t}] { io\+ \_ \+ int, } \item [{gpio\+\_\+num\+\_\+t}] { io\+ \_ \+ rst, } \item [{uint32\+\_\+t}] { sclk\+ \_ \+ speed, } \item [{bool}] { install\+ \_ \+ isr\+ \_ \+ service = { \ttfamily true} } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [inline]} }
Overloaded IMU configuration settings constructor for custom pin settings.
\doxysubsection { Member Data Documentation}
\Hypertarget { structbno08x_ _ config_ _ t_ a0f629aaef6756aa80fec96b34476c627} \label { structbno08x_ _ config_ _ t_ a0f629aaef6756aa80fec96b34476c627}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !install\_ isr\_ service@{ install\_ isr\_ service} }
\index { install\_ isr\_ service@{ install\_ isr\_ service} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { install\_ isr\_ service} { install\_ isr\_ service} }
{ \footnotesize \ttfamily bool bno08x\+ \_ \+ config\+ \_ \+ t\+ ::install\+ \_ \+ isr\+ \_ \+ service}
Indicates whether the ISR service for the HINT should be installed at IMU initialization, (if gpio\+ \_ \+ install\+ \_ \+ isr\+ \_ \+ service() is called before initialize() set this to false)
\Hypertarget { structbno08x_ _ config_ _ t_ ab1b5351b63da0c172c942463d0dc2505} \label { structbno08x_ _ config_ _ t_ ab1b5351b63da0c172c942463d0dc2505}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !io\_ cs@{ io\_ cs} }
\index { io\_ cs@{ io\_ cs} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { io\_ cs} { io\_ cs} }
{ \footnotesize \ttfamily gpio\+ \_ \+ num\+ \_ \+ t bno08x\+ \_ \+ config\+ \_ \+ t\+ ::io\+ \_ \+ cs}
\Hypertarget { structbno08x_ _ config_ _ t_ a3cfe965659cfbc6b0c5269bd0211975f} \label { structbno08x_ _ config_ _ t_ a3cfe965659cfbc6b0c5269bd0211975f}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !io\_ int@{ io\_ int} }
\index { io\_ int@{ io\_ int} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { io\_ int} { io\_ int} }
{ \footnotesize \ttfamily gpio\+ \_ \+ num\+ \_ \+ t bno08x\+ \_ \+ config\+ \_ \+ t\+ ::io\+ \_ \+ int}
Chip select pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} CS pin)
\Hypertarget { structbno08x_ _ config_ _ t_ a9468180a773892977db39cc5ed9368e3} \label { structbno08x_ _ config_ _ t_ a9468180a773892977db39cc5ed9368e3}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !io\_ miso@{ io\_ miso} }
\index { io\_ miso@{ io\_ miso} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { io\_ miso} { io\_ miso} }
{ \footnotesize \ttfamily gpio\+ \_ \+ num\+ \_ \+ t bno08x\+ \_ \+ config\+ \_ \+ t\+ ::io\+ \_ \+ miso}
MISO GPIO pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} SDA pin)
\Hypertarget { structbno08x_ _ config_ _ t_ a79023fd80039e41a22b7f73ccd5fc861} \label { structbno08x_ _ config_ _ t_ a79023fd80039e41a22b7f73ccd5fc861}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !io\_ mosi@{ io\_ mosi} }
\index { io\_ mosi@{ io\_ mosi} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { io\_ mosi} { io\_ mosi} }
{ \footnotesize \ttfamily gpio\+ \_ \+ num\+ \_ \+ t bno08x\+ \_ \+ config\+ \_ \+ t\+ ::io\+ \_ \+ mosi}
MOSI GPIO pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} DI pin)
\Hypertarget { structbno08x_ _ config_ _ t_ a62745c761219139f66ecd173b51577fc} \label { structbno08x_ _ config_ _ t_ a62745c761219139f66ecd173b51577fc}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !io\_ rst@{ io\_ rst} }
\index { io\_ rst@{ io\_ rst} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { io\_ rst} { io\_ rst} }
{ \footnotesize \ttfamily gpio\+ \_ \+ num\+ \_ \+ t bno08x\+ \_ \+ config\+ \_ \+ t\+ ::io\+ \_ \+ rst}
Host interrupt pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} INT pin)
\Hypertarget { structbno08x_ _ config_ _ t_ a639685b91ae3198909d722316495246a} \label { structbno08x_ _ config_ _ t_ a639685b91ae3198909d722316495246a}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !io\_ sclk@{ io\_ sclk} }
\index { io\_ sclk@{ io\_ sclk} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { io\_ sclk} { io\_ sclk} }
{ \footnotesize \ttfamily gpio\+ \_ \+ num\+ \_ \+ t bno08x\+ \_ \+ config\+ \_ \+ t\+ ::io\+ \_ \+ sclk}
SCLK pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} SCL pin)
\Hypertarget { structbno08x_ _ config_ _ t_ a231614c3b20888360def2ce9db83f52a} \label { structbno08x_ _ config_ _ t_ a231614c3b20888360def2ce9db83f52a}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !sclk\_ speed@{ sclk\_ speed} }
\index { sclk\_ speed@{ sclk\_ speed} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { sclk\_ speed} { sclk\_ speed} }
{ \footnotesize \ttfamily uint32\+ \_ \+ t bno08x\+ \_ \+ config\+ \_ \+ t\+ ::sclk\+ \_ \+ speed}
Reset pin (connects to \doxylink { class_ b_ n_ o08x} { BNO08x} RST pin)
Desired SPI SCLK speed in Hz (max 3MHz) \Hypertarget { structbno08x_ _ config_ _ t_ a020d2343750bb7debc2a108ae038c9ec} \label { structbno08x_ _ config_ _ t_ a020d2343750bb7debc2a108ae038c9ec}
\index { bno08x\_ config\_ t@{ bno08x\_ config\_ t} !spi\_ peripheral@{ spi\_ peripheral} }
\index { spi\_ peripheral@{ spi\_ peripheral} !bno08x\_ config\_ t@{ bno08x\_ config\_ t} }
\doxysubsubsection { \texorpdfstring { spi\_ peripheral} { spi\_ peripheral} }
{ \footnotesize \ttfamily spi\+ \_ \+ host\+ \_ \+ device\+ \_ \+ t bno08x\+ \_ \+ config\+ \_ \+ t\+ ::spi\+ \_ \+ peripheral}
SPI peripheral to be used.
The documentation for this struct was generated from the following file\+ :\begin { DoxyCompactItemize}
\item
2024-12-27 02:02:09 +00:00
include/\mbox { \hyperlink { _ b_ n_ o08x_ global_ types_ 8hpp} { BNO08x\+ Global\+ Types.\+ hpp} } \end { DoxyCompactItemize}
