Skip to content

Latest commit

 

History

History
87 lines (54 loc) · 4.29 KB

README-ARDUINO.md

File metadata and controls

87 lines (54 loc) · 4.29 KB
Raw

WakaTime for Arduino IDE

Version Installs WakaTime

WakaTime is an open source VS Code plugin for metrics, insights, and time tracking automatically generated from your programming activity.

Arduino IDE 2.x has been entirely rewritten and share no code with 1.x. The new IDE is based on Theia IDE framework and build with Electron. It natively supports VSCODE extensions so we can use WakaTime VSCODE extension to track your coding time.

Installation

Unfortunately there's no native way to install VSCODE extensions in Arduino IDE so far. So we have to install it manually.

  1. Download the latest vscode-wakatime plugin vsix from open-vsx.org.
  2. Rename the .vsix file to .zip.
  3. Extract the zip file into ~/.arduinoIDE/plugins/vscode-wakatime.
  4. Relaunch your Arduino IDE.
  5. Enter your api key, then press enter.

    (If you’re not prompted, press F1 or ⌘ + Shift + P then type WakaTime API Key.)

  6. Use Arduino IDE like you normally do and your coding activity will be displayed on your WakaTime Dashboard.

Usage

Visit https://wakatime.com to see your coding activity.

Project Overview

Configuring

VS Code specific settings are available from ⌘ + Shift + P, then typing wakatime.

For example, to hide today's coding activity in your status bar:

Press ⌘ + Shift + P then set WakaTime: Status Bar Coding Activity to false.

Extension settings are stored in the INI file at $HOME/.wakatime.cfg.

More information can be found from wakatime-cli.

Notes:

  1. $HOME defaults to $HOME
  2. To disable the extension at startup add disabled=true to your config, this operation can also be performed by pressing ⌘ + Shift + P and selecting WakaTime: Disable.

Troubleshooting

First, turn on debug mode:

  1. Press F1 or ⌘ + Shift + P
  2. Type > WakaTime: Debug, and press Enter.
  3. Select true, then press Enter.

Next, open your Developer Console to view logs and errors:

Help → Toggle Developer Tools

Errors outside the scope of vscode-wakatime go to $HOME/.wakatime/wakatime.log from wakatime-cli.

The How to Debug Plugins guide shows how to check when coding activity was last received from your editor using the Plugins Status Page.

Microsoft Windows Only: Using WakaTime behind a corporate proxy? Try enabling your Windows Root Certs inside VS Code with the win-ca extension: Press Ctrl + Shift + X, search for win-ca, press Install.

For more general troubleshooting info, see the wakatime-cli Troubleshooting Section.

Uninstalling

  1. Delete folder ~/.arduinoIDE/plugins/vscode-wakatime.

Contributing

Pull requests, bug reports, and feature requests are welcome! Please search existing issues before creating a new one.

Many thanks to all contributors!

Made with ❤️ by the WakaTime Team.