Motorcortex

A Visual Studio Code extension that streamlines Motorcortex development and deployment workflows for Fitlet 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 Fitlet deployment.

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 Fitlet devices for remote control and deployment
• Git (optional, for cloning templates)

Extension Settings

• motorcortex.pythonPath: Path to the Python executable (default: python3)
• motorcortex.useGitTemplate: Use Git to clone the template (default: true)
• motorcortex.gitTemplateBranch: Branch to use when cloning templates (default: main)
• motorcortex.fitletIp: IP address of your Fitlet device (default: 192.168.2.100)
• motorcortex.fitletUsername: SSH username for the Fitlet device (default: vectioneer)
• motorcortex.buildDebian.useLocalDeploying: Path to the local deploying folder in the workspace to use instead of the extension's built-in deploying resources. Leave empty to use extension resources (default: ``)

Getting Started

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

Available Commands

• Motorcortex: Refresh Status — Update service status information
• Motorcortex: Start Motorcortex Service — Start the service on the Fitlet
• Motorcortex: Stop Motorcortex Service — Stop the service on the Fitlet
• Motorcortex: Restart Motorcortex Service — Restart the service on the Fitlet
• Motorcortex: Create Python MCX Client App — Scaffold a Python client application
• Motorcortex: Build Debian Package — Build a Debian package for deployment
• Motorcortex: Setup SSH Key Authentication — Set up SSH key authentication for the Fitlet
• Motorcortex: Open Settings — Open the settings for the Motorcortex extension
• Motorcortex: Copy Deploying folder - Copy the deploying folder from the extension to your workspace for full customisation

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 a local template folder or provide a Git template URL/branch.
3. The extension will create a virtual environment and install dependencies.
4. Use Motorcortex: Build Debian Package to produce a deployable .deb for Fitlet devices.

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!