OSSM Project Documentation

Welcome to the Open Source Sex Machine (OSSM) project! This guide will help you understand our project structure and get started with development.

Project Overview

OSSM is an ESP32-based control system for automated motion devices. The project uses PlatformIO for development and leverages several key technologies:

Core Technologies

  • State Machine: Built with Boost SML for robust state management

  • Display: OLED display using U8G2 library for UI

  • Task Management: FreeRTOS for concurrent operations

  • Motion Control: Elims' StrokeEngine modified for OSSM usage.

Getting Started

  1. Install VSCode and the PlatformIO extension, you can also follow our guide here.

  2. Clone the repository

  3. Open the project in VSCode with PlatformIO

  4. Review our PlatformIO setup guide for detailed instructions

Last updated