Jacdac TypeScript and Documentation

Jacdac is a bus-based plug-and-play hardware/software stack for microcontrollers and their peripherals (sensors/actuators), with applications to rapid prototyping, making, and physical computing.

This repository contains a TypeScript/JavaScript client library for the Jacdac protocol, as well as the source of https://aka.ms/jacdac under /docs.

• User Documentation
• Discussions at https://github.com/microsoft/jacdac/discussions
• Issues are tracked on https://github.com/microsoft/jacdac/issues

The rest of this page is for developers of the jacdac-ts library.

Developer setup

Codespaces

Edit this project directly from your browser using GitHub Codespaces. If you have access to them,

• open project in a new codespace
• launch the docs server

yarn docs

• click on the generated URL in the terminal output and voila!

Local Setup

• clone this repository and pull all submodules

git clone https://github.com/microsoft/jacdac-ts
git submodule update --init --recursive
git pull

• install node.js
• install yarn

npm install -g yarn

• install dependencies

yarn installdev

VS Code

You are welcome to use any editor you want! Visual Studio Code provides seamless support for git sub-modules and is our preferred editor.

• open Visual Studio Code

code .

• in the Git view, click on the jacdac branch and select main so that changes are automatically synched
• install MDX support in VS Code https://marketplace.visualstudio.com/items?itemName=silvenon.mdx

Specs build

To regenerate the service definition JSON files from the .md files in jacdac-spec, run

yarn buildspecs

Unit tests

We use Mocha to run the unit test suite from /tests. To execute the tests,

yarn test

Linting

Run the following command to detect linting issues

yarn lint

Docs build

Launch the gatsbdy develop mode and navigate to http://localhost:8000 . This build does not require to load dist as the library is compiled directly into the web site.

• install the docs packages

yarn installdocs

• run the docs web site locally

yarn docs

• browse to the local server

http://localhost:8000?dbg=1

To analyze the webpack bundle size,

cd docs
gatsby build
gatsby serve
nav to http://127.0.0.1:3001

Jacdac+MakeCode

Local build

Run this command to rebuild the makecode packages

yarn buildpxt

Local debugging

Open the multi editor to test MakeCode devices with the Jacdac view. You can select to run Jacdac and/or MakeCode on localhost/web from the drop downs.

https://makecode.com/multi?jacdac=1&localhost=1&beta=1

Adding a new MakeCode client

Create a new issue in https://github.com/microsoft/jacdac and select the MakeCode client template.

HTML tools

You can do npm run watch to watch/build bundles. Bundles are placed under the dist folder.

yarn watch

On another terminal, launch a small web server and try all the tools under docs/static/tools/* at http://localhost:8080/docs/static/tools/js/console.html . These tools load the files under dist so you'll want to also run npm run watch on the side.

yarn tools

• console http://localhost:8080/docs/static/tools/js/console.html
• devices http://localhost:8080/docs/static/tools/js/devices.html
• flashing http://localhost:8080/docs/static/tools/js/flashing.html
• namer http://localhost:8080/docs/static/tools/js/namer.html
• tfite http://localhost:8080/docs/static/tools/js/tflite.html
• streaming http://localhost:8080/docs/static/tools/js/streaming.html
• streaming-rickshaw: http://localhost:8080/docs/static/tools/js/streaming-rickshaw.html

Commits create releases

The releases are automatically created by the build system based on the title of the commit:

• patch|fix:... patch
• minor:feature:... minor

NPM scripts

• npm run watch: Run npm run build in watch mode
• npm run lint: Lints code
• npm run docs: Launch docs web service

Microsoft Open Source Code of Conduct

This project is hosted at https://github.com/microsoft/jacdac-ts. This project has adopted the Microsoft Open Source Code of Conduct.

Resources:

• Microsoft Open Source Code of Conduct
• Microsoft Code of Conduct FAQ
• Contact opencode@microsoft.com with questions or concerns