From 3d8ac86b2f4ee417c9ef74b355362b6ce106cffb Mon Sep 17 00:00:00 2001 From: Nathan Kunicki Date: Thu, 21 Jun 2018 18:31:22 +0100 Subject: [PATCH] More documentation --- DOCS.md | 2 ++ README.md | 2 ++ boosthub.ts | 2 ++ 3 files changed, 6 insertions(+) diff --git a/DOCS.md b/DOCS.md index 55f2f83..9993f97 100644 --- a/DOCS.md +++ b/DOCS.md @@ -173,6 +173,8 @@ Emits when a color sensor is activated. ### "tilt" (port, x, y) Emits when a tilt sensor is activated. +Note: If the event if fired from the Move Hub's inbuild tilt sensor, the special port "TILT" is used. + **Kind**: event emitted by [BoostHub](#BoostHub) | Param | Type | diff --git a/README.md b/README.md index 8662949..cb37624 100644 --- a/README.md +++ b/README.md @@ -213,6 +213,8 @@ Emits when a color sensor is activated. ### "tilt" (port, x, y) Emits when a tilt sensor is activated. +Note: If the event if fired from the Move Hub's inbuild tilt sensor, the special port "TILT" is used. + **Kind**: event emitted by [BoostHub](#BoostHub) | Param | Type | diff --git a/boosthub.ts b/boosthub.ts index ee17ed2..679f591 100644 --- a/boosthub.ts +++ b/boosthub.ts @@ -321,6 +321,8 @@ export class BoostHub extends Hub { this._lastTiltY = tiltY; /** * Emits when a tilt sensor is activated. + * + * Note: If the event if fired from the Move Hub's inbuild tilt sensor, the special port "TILT" is used. * @event BoostHub#tilt * @param {string} port * @param {number} x