From 62c629e3de9fcaea07f4f187ff90fe40cf2b0e8d Mon Sep 17 00:00:00 2001 From: peli Date: Thu, 11 Feb 2021 20:07:03 -0800 Subject: [PATCH] JACDAC => Jacdac --- README.md | 4 ++-- diagnostics.ts | 2 +- docs/reference/jacdac.md | 14 +++++--------- jdsim.ts | 2 +- ns.ts | 6 +++--- routing.ts | 4 ++-- sim/state.ts | 6 +++--- 7 files changed, 17 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 630f86ea6..ede271b91 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# JACDAC Services for MakeCode +# Jacdac Services for MakeCode -This project contains [JACDAC](https://aka.ms/jacdac) host and client services for MakeCode editors. +This project contains [Jacdac](https://aka.ms/jacdac) host and client services for MakeCode editors. **This project is still under construction.** diff --git a/diagnostics.ts b/diagnostics.ts index f892a1094..401ce084c 100644 --- a/diagnostics.ts +++ b/diagnostics.ts @@ -1,6 +1,6 @@ namespace jacdac { /** - * Gets the internal diagnostics data from the JACDAC transport layer + * Gets the internal diagnostics data from the Jacdac transport layer */ export function diagnostics(): jacdac.JDDiagnostics { return new jacdac.JDDiagnostics(jacdac.__physGetDiagnostics()); diff --git a/docs/reference/jacdac.md b/docs/reference/jacdac.md index a0f4487db..81e1e67ed 100644 --- a/docs/reference/jacdac.md +++ b/docs/reference/jacdac.md @@ -1,22 +1,18 @@ -# JACDAC +# Jacdac ## ~ hint -**JACDAC is still in early prototyping phase.** The protocol and all hardware design are MOST LIKELY to change during this phase. You are welcome to join us in prototyping but we strongly recommend avoiding going to production with JACDAC at the current stage. - -To join the discussion, join us on [Discord](https://discord.gg/9WMc5Es). +**Jacdac is still in early prototyping phase.** The protocol and all hardware design are MOST LIKELY to change during this phase. You are welcome to join us in prototyping but we strongly recommend avoiding going to production with Jacdac at the current stage. ## ~ -JACDAC ([jacdac.org](https://jacdac.org)) stands for "Joint Asynchronous Communications; Device Agnostic Control.". It is a bus-based protocol to connect low powered devices. - ### Pin configuration -The following pins must be configured ``config.ts`` for JACDAC to work on a board. +The following pins must be configured ``config.ts`` for Jacdac to work on a board. -* ``PIN_JACK_TX``: pin with EINT, SERCOM[0]. To determine if the pin is compatible with JACDAC, consult the MCU schematics. +* ``PIN_JACK_TX``: pin with EINT, SERCOM[0]. To determine if the pin is compatible with Jacdac, consult the MCU schematics. * (optional) ``PIN_JACK_COMMLED``: LED pin, blinks when packet is received or transmitted -* (optional) ``JACK_BUSLED``: LED pin, turns on when JACDAC is connected +* (optional) ``JACK_BUSLED``: LED pin, turns on when Jacdac is connected ### Simulator configuration diff --git a/jdsim.ts b/jdsim.ts index 6eaacd74f..492dffe78 100644 --- a/jdsim.ts +++ b/jdsim.ts @@ -66,7 +66,7 @@ namespace jacdac { } /** - * Starts the JACDAC physical layer. + * Starts the Jacdac physical layer. **/ //% shim=jacdac::__physStart export function __physStart(): void { diff --git a/ns.ts b/ns.ts index adf41f6f9..c990fa41d 100644 --- a/ns.ts +++ b/ns.ts @@ -1,15 +1,15 @@ /** - * JACDAC services + * Jacdac services */ //% weight=50 icon="\uf2db" color="#009900" advanced=true //% blockGap=8 //% groups='["Broadcast", "Console", "Controller", "Services", "Control"]' -//% blockNamespace="JACDAC" +//% blockNamespace="Jacdac" namespace jacdac { } /** - * JACDAC modules + * Jacdac modules */ //% weight=80 icon="\uf2db" color="#009900" //% blockGap=8 diff --git a/routing.ts b/routing.ts index 8a1d6decc..b6182fa7f 100644 --- a/routing.ts +++ b/routing.ts @@ -695,7 +695,7 @@ namespace jacdac { } /** - * Gets the JACDAC device representing the running device + * Gets the Jacdac device representing the running device */ export function selfDevice() { if (!_myDevice) { @@ -968,7 +968,7 @@ namespace jacdac { } /** - * Starts the JACDAC service + * Starts the Jacdac service */ export function start(options?: { disableLogger?: boolean, diff --git a/sim/state.ts b/sim/state.ts index ac823469d..d18ae38cb 100644 --- a/sim/state.ts +++ b/sim/state.ts @@ -113,7 +113,7 @@ namespace pxsim.jacdac { } /** - * Returns the connection state of the JACDAC physical layer. + * Returns the connection state of the Jacdac physical layer. **/ export function __physIsConnected(): boolean { const state = getJacDacState(); @@ -129,7 +129,7 @@ namespace pxsim.jacdac { } /** - * Starts the JACDAC physical layer. + * Starts the Jacdac physical layer. **/ export function __physStart(): void { const state = getJacDacState(); @@ -138,7 +138,7 @@ namespace pxsim.jacdac { } /** - * Stops the JACDAC physical layer. + * Stops the Jacdac physical layer. **/ export function __physStop(): void { const state = getJacDacState();