Quirkbot Arduino Hardware

Building releases

You should build and test the release before deploying them:

• Install node dependencies:

npm install

• Update the version in package.json
• Run:

npm run gulp -- build

Deploying Releases

To deploy to Amazon S3, please create the corresponding configuration files in /aws-config/[environment].json. For security, those files should not be included on the repository.

Examples:

/aws-config/stage.json

{
  "key": "YOUR_S3_KEY",
  "secret": "YOUR_S3_SECRET",
  "bucket": "code-stage.quirkbot.com",
  "region": "us-east-1"
}

/aws-config/production.json

{
  "key": "YOUR_S3_KEY",
  "secret": "YOUR_S3_SECRET",
  "bucket": "code.quirkbot.com",
  "region": "us-east-1"
}

Before deploying, please run the "Building Releases" instructions and make sure everything works as desired. When you are ready to deploy:

• Update the version in package.json
• Run:

npm run gulp -- deploy --environment=stage

or

npm run gulp -- deploy --environment=production

• When you are completely satisfied with the deployed release, run:

npm publish

• Create a git tag.
• Make a manual Github release and upload the generated quirkbot-arduino-hardware-*.zip.
• Make sure to update the Unofficial list of 3rd party boards support urls.

Updating dependencies

Make sure to keep this updated!

Arduino Core

Copied from Arduino AVR Boards.

Check what is the latest version at the package index.

You need to patch the D_CONFIG macro from USBCore.h so it reports the board as self powered and with a maximum consumption of 100mA.

#define D_CONFIG(_totalLength,_interfaces) \
	{ 9, 2, _totalLength,_interfaces, 1, 0, USB_CONFIG_POWERED_MASK | USB_CONFIG_REMOTE_WAKEUP, USB_CONFIG_POWER_MA(100) }

You need to patch CDC.cpp auto-reset routine. Replace the content of lines 95 - 137 with:

if (CDC_SET_LINE_CODING == r || CDC_SET_CONTROL_LINE_STATE == r)
{
	if (1200 == _usbLineInfo.dwDTERate && (_usbLineInfo.lineState & 0x01) == 0)
	{
		*(uint16_t *)0x0800 = 0x7777;
		wdt_enable(WDTO_120MS);
		for (;;);
	}
	else
	{
		wdt_disable();
		wdt_reset();
	}
}

You need to patch USBCore.cpp USB_Send function. We want to remove the 250 timeout completely.

Replace the block:

u8 n = USB_SendSpace(ep);
if (n == 0)
{
    if (!(--timeout))
        return -1;
    delay(1);
    continue;
}

With:

u8 n = USB_SendSpace(ep);
if (n == 0)
{
    return -1;
}

Libraries

HID

Copied from Arduino AVR Boards.

Check what is the latest version at the package index.

Servo

From git - https://github.com/Quirkbot/Servo

Keyboard

From git - https://github.com/Quirkbot/Keyboard

Mouse

From git - https://github.com/Quirkbot/Mouse

MIDIUSB

From git - https://github.com/Quirkbot/MIDIUSB

You need to patch the getShortName function from MIDIUSB.cpp so it doesn't set any name (we don't want Arduino to set a serial number in the USB descriptors):

uint8_t MIDI_::getShortName(char* name)
{
    return 0;
}