# LEGO Tools

**Repository Path**: frank-deng/lego-tools

## Basic Information

- **Project Name**: LEGO Tools
- **Description**: Control LEGO 42099 via joystick.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-28
- **Last Updated**: 2024-07-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

LEGO Tools
==========

Control LEGO 42099 and 42146 via joystick.

Hardware And Software Requirements
----------------------------------

* An individual bluetooth dongle used for controlling LEGO hubs (DO NOT use the one used for bluetooth audio).
* A joystick with at least 2 analog axises required.
* VirtualBox Debian/Ubuntu guest with bluetooth-related packages installed.
* Connect bluetooth adapter and joystick to the VirtualBox Debian/Ubuntu guest.
* Run command `sudo apt-get install libcap2-bin` to install `setcap` for the guest.
* Run command `sudo setcap cap_net_raw+eip /usr/bin/node` every time when nodejs is installed/upgraded inside guest, so as to enable nodejs accessing bluetooth without root privillege.
* Add current user to group `input` to get joystick work.

Commands
--------

|Command|Description|
|-------|-----------|
|`npm start`|Start main program.|
|`npm run calibrate`|Same as `npm start`, while steering calibration will be done during initialization.|
|`npm run test-joystick`|Get joystick name, axis name, button name, etc. of your joysticks.|
|`npm run detect-hubs`|Get ID, name, battery level of detected LEGO hubs, useful when you have to specify which hub ID to connect.|

Configuration
-------------

`config.json` can be found at the root folder of this repository, following are comments for all the configuration items:

	{
	  "joystick":null,    //Specify joystick name. Leave it null if only one joystick is connected.
	  "hubId":null,       //Specify the hub ID to connect. Leave it null when you have only one LEGO hub available.
	  "steer":{
	    "axis":"ABS_X",   //Specify the joystick axis used for steering
	    "reverse":false   //Specify whether the joystick axis should be reversed
	  },
	  "throttle":{
	    "axis":"ABS_RZ",  //Specify the joystick axis used for throttle
	    "reverse":false   //Specify whether the joystick axis should be reversed
	  },
	  "brakeButton":"BTN_START"  //Specify the joystick button used for stopping all the motors and reverting steering to middle position
	}

TODO
----

* Use `process.exit()` always hangs, and I haven't figured out why. `SIGQUIT` is used to terminate the program at present.