mistycommunity / javascript-sdk

Sample code, tutorials, and other resources for working with the Misty II JavaScript SDK.

Misty II JavaScript SDK

This repository provides runnable sample code, tutorials, and sandbox projects to help you create skills with Misty's JavaScript SDK.

For different examples of how to use Misty's .NET SDK and REST API, see the .NET-SDK and REST-API repositories.

Using this repository

Use the green Clone or download button to create a local version of this repository on your desktop. The repository includes three directories:

• Sample Code - Runnable examples that demonstrate how to perform different tasks with Misty's JavaScript SDK. Refer to these samples (or copy and paste the code into your own JavaScript skills) when developing skills that require similar functionality.
• Tutorials - Complete, runnable skills from the written tutorials published in the Misty Robotics developer documentation.
• Sandbox - A collection of skills and code samples that are not actively maintained by the Misty team. Some of these skills require external hardware or integrations with third-party services. Sandbox code may not be up-to-date with Misty's current software.

You can run the JavaScript code samples from this repository on your own Misty II by uploading the code and meta files to Misty via the Skill Runner web tool, or by using the Misty JavaScript extension for Visual Studio Code. Refer to these code samples (or copy and paste them into your own skills) when working on similar functionality in your own skill development.

Find something that doesn't work? Help us fix it by creating an issue right here in the JavaScript-SDK repository! Along with a brief description of the issue, let us know what operating system you're using and what version of Misty's software you're working with. If you can, write down the steps to reproduce the issue, and be sure to include any relevant screenshots or error messages. Sharing this information helps us discover the root cause more quickly.

---

WARRANTY DISCLAIMER.

• General. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, MISTY ROBOTICS PROVIDES THIS SAMPLE SOFTWARE “AS-IS” AND DISCLAIMS ALL WARRANTIES AND CONDITIONS, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, QUIET ENJOYMENT, ACCURACY, AND NON-INFRINGEMENT OF THIRD-PARTY RIGHTS. MISTY ROBOTICS DOES NOT GUARANTEE ANY SPECIFIC RESULTS FROM THE USE OF THIS SAMPLE SOFTWARE. MISTY ROBOTICS MAKES NO WARRANTY THAT THIS SAMPLE SOFTWARE WILL BE UNINTERRUPTED, FREE OF VIRUSES OR OTHER HARMFUL CODE, TIMELY, SECURE, OR ERROR-FREE.
• Use at Your Own Risk. YOU USE THIS SAMPLE SOFTWARE AND THE PRODUCT AT YOUR OWN DISCRETION AND RISK. YOU WILL BE SOLELY RESPONSIBLE FOR (AND MISTY ROBOTICS DISCLAIMS) ANY AND ALL LOSS, LIABILITY, OR DAMAGES, INCLUDING TO ANY HOME, PERSONAL ITEMS, PRODUCT, OTHER PERIPHERALS CONNECTED TO THE PRODUCT, COMPUTER, AND MOBILE DEVICE, RESULTING FROM YOUR USE OF THIS SAMPLE SOFTWARE OR PRODUCT.

Please refer to the Misty Robotics End User License Agreement for further information and full details: https://www.mistyrobotics.com/legal/end-user-license-agreement/

---

Copyright 2020 Misty Robotics
Licensed under the Apache License, Version 2.0
http://www.apache.org/licenses/LICENSE-2.0

javascript-sdk's Issues

Problem with subscription to SelfState in "Explore"

There seems to be a bug in the Explore script where the subscription to SelfState does not access the appropriate message, which prevents the rest of the script from executing correctly.

Issue with FaceRecognition subscription in "Roar"

When running the code for the "Roar" skill, Misty returns a value of undefined for the data.message.distance property on line 50. It looks like no distance value is getting returned in the data object returned by the first message sent by the subscription. I think we need to incorporate a conditional statement so that Misty does not react when the initial "successful subscription" message is sent, and instead Misty waits for a real face rec event that contains meaningful data.

LICENSE file in root of sourcetree?

At least some of this code appears to be under the MIT license, e.g., Skills/Skill-Explore/Explore.html.

Can you add a declaration of license to the README, or add a dedicated LICENSE file (e.g., like that of https://github.com/MistyCommunity/Documentation but not CC-SA)?

This is motivated to make the license easier to find.

UWP API_Wrapper should be moved to REST-API repository

The UWP API Wrapper (and the associated UWP app in the Sandbox directory) use Misty's REST API, not her JavaScript SDK, and should be moved to the sandbox directory in the REST-API repository.

Missing contribution guidelines

There are no guidelines for contributing to the MistyI repository. We should write guidelines to encourage contribution and engagement with skills developed by and for the Misty community.

Misty plays audio before she finds a face in "Move - Find Face - Do Something"

Misty plays audio as soon as you subscribe to FaceRecognition events. There is no validation of FaceRecognition data to ensure that Misty actually detected a face, and so Misty reacts to the first websocket message. This message only contains meta information about the subscription; it doesn't actually have data about the FaceRecognition event. I think the problem here is similar to what we see with issue #7