Home

Welcome to the Scarlet wiki!

Currently, documentation is still mainly in the OneNote notebook. We're in the process of moving things over.

Scarlet is a C# robotics library, originally designed for the Husky Robotics' 2017-18 rover's science station. It is meant to be modular, flexible, cross-platform, and usable by all subsystems, and anyone else. Some current library features include:

• Packet building, interpreting, and networking (send/receive, connection management)
• Sensor and motor frameworks, and several sensor/motor implementations
• Raspberry Pi and BeagleBone Black hardware interfacing (GPIO, Interrupts, PWM, I2C, SPI, UART, CAN, ADC)
• Simple persistent data storage
• Filters
• Configurable logging
• CSV saving utilities
• Some miscellaneous utilities

Check the list of supported hardware to see how Scarlet can fit your needs.

Getting Started:

You're already reading the documentation, so you're off to an excellent start. We highly recommend that you use Visual Studio 2017 Community, as we have projects, build configurations, and versions set up to work out of the box. You can then copy the projects and use our Science solution as a reference for setting up your own project. Then, have a look over the next few pages to get an idea of how the library works. Once you're ready to see more, have a look over our code. This library was intended for the science station, so we're using it extensively.

Problems?

Found something that seems to be wrong? Keep in mind that we're far from pro developers, so there's probably things broken or things that could be made better. You're welcome to suggest or contribute changes. If you do, please adhere to the style guidelines here. We'd appreciate if you didn't simply change things, but please do feel free to send us a message on Slack (we'll be in the #scarlet channel), submit an issue here on GitHub, or submit a pull request.