Motorcortex

A Visual Studio Code extension that streamlines Motorcortex development and deployment workflows for Target devices.

For the documentation, please visit the VsCode Motorcortex Extension Documentation.

Features

Motorcortex Control & Status

• Start / Stop / Restart Motorcortex remotely via SSH.
• Dedicated sidebar view showing Motorcortex status.
• Status bar connection indicator with live updates.

Python Client & Packaging

• Create Python MCX Client App: scaffold a ready-to-run Python client application from a local or Git-based template.
• Automatic virtual environment creation and dependency installation.
• One-click Build Debian Package integrated into the client workflow for easy Target deployment.

C++ Control Development

• Create C++ MCX Control App: scaffold a complete C++ control application from template.
• Create C++ MCX Control Module: quickly generate C++ module files (header and/or source) with proper Motorcortex structure.
• Convenient buttons to build, run and debug C++ control applications.

Motorcortex Websites

• Easy access to Motorcortex official websites and documentation via sidebar links:
  • Portal
  • GRID
  • Cockpit
  • Desk Tool

Requirements

• Visual Studio Code
• Python 3.8+ (for client scaffold and packaging tasks)
• SSH access to Target devices for remote control and deployment
• Git (optional, for cloning templates)

Extension Settings

Below are the available configuration options for the Motorcortex VS Code extension. These settings can be added to your settings.json or configured via the VS Code settings UI.

Getting Started

1. Install the extension from the VS Code Marketplace
2. Configure your Target IP in settings: motorcortex.targetIp
3. Use the Command Palette (Ctrl+Shift+P) or the Motorcortex sidebar to access commands

Available Commands

To view the available commands provided by the Motorcortex extension, you can open the Command Palette in VS Code by pressing Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac). Then, type Motorcortex to filter the commands related to the Motorcortex extension.

Usage

Status & Service Control

1. Open the Motorcortex sidebar to view service health and connection state.
2. Use the status bar indicator for quick connection health and click to refresh.
3. Control services via the sidebar entries or the Command Palette commands.

Creating and Packaging a Python MCX Client App

1. Run Motorcortex: Create Python MCX Client App from the Command Palette.
2. Choose the folder and name for your new client application.
3. The extension will create a virtual environment and install dependencies.
4. Use Motorcortex: Build Debian Package to produce a deployable .deb for Target devices.

Creating C++ MCX Control Applications and Modules

1. Full Control App: Run Motorcortex: Create C++ MCX Control App to scaffold a complete C++ control application with all necessary configuration files.
2. Individual Modules:
   • Use Motorcortex: Create C++ MCX Control Module from the Command Palette or sidebar
   • Or right-click any folder or C++ file in the Explorer and select "Create Motorcortex control module"
   • Provide a module name (e.g., "MyMotor", "Sensor")
   • Choose to generate both header and source files, or header only
   • Files are created with proper Motorcortex module structure and your custom name

Quick Links

• Official Website: Motorcortex.io
• GitHub: VsCode Motorcortex Extension Repository

Support

For issues or feature requests, open an issue at the GitHub repository above.

Enjoy developing with Motorcortex!

Known issues

• Docker installed via SNAP may cause issues with building Debian packages. If you encounter problems, consider reinstalling Docker using the official installation method from Docker's website.