@@ -35,28 +35,28 @@ colcon build
3535
3636## Usage
3737
38- The X-Series Driver is compiled as a library and can be used in any C++ project by simply including its headers.
38+ The X-Series Driver is compiled as a library and can be used in any C++ project by simply including its headers and linking against it .
3939
4040``` c++
4141#include " interbotix_xs_driver/xs_logging.hpp" // Logging macros and utils
4242#include " interbotix_xs_driver/xs_common.hpp" // Common variables and types
43- #include " interbotix_xs_driver/xs_driver.hpp" // InterbotixDriverXS class
43+ #include " interbotix_xs_driver/xs_driver.hpp" // The InterbotixDriverXS class
4444```
4545
46- Then create an InterbotixDriverXS object, providing the following in the order stated:
47- - Reference to a ` success ` boolean, indicating whether or not the object was initialized properly
46+ Then create an ` InterbotixDriverXS ` object, providing the following in the order stated:
4847- Absolute filepath to the motor configs file
4948- Absolute filepath to the mode configs file
5049- A boolean indicating whether the Driver should write to the EEPROM on startup
50+ - A string indicating the driver's logging level containing one of the following: "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
5151
5252This initialization would look something like below:
5353
5454``` c++
55- std::shared_ptr <InterbotixDriverXS> xs_driver = std::make_shared <InterbotixDriverXS>(
56- success ,
57- filepath_motor_configs ,
58- filepath_mode_configs ,
59- write_eeprom_on_startup );
55+ std::unique_ptr <InterbotixDriverXS> xs_driver = std::make_unique <InterbotixDriverXS>(
56+ filepath_motor_configs ,
57+ filepath_mode_configs ,
58+ write_eeprom_on_startup ,
59+ logging_level );
6060```
6161
6262See the package's source code for more details.
0 commit comments