https://github.com/mechazawa/minidrone-js
🚁 Parrot Minidrone library
https://github.com/mechazawa/minidrone-js
ble bluetooth bluetooth-low-energy drone mambo minidrone parrot
Last synced: about 2 months ago
JSON representation
🚁 Parrot Minidrone library
- Host: GitHub
- URL: https://github.com/mechazawa/minidrone-js
- Owner: Mechazawa
- License: mit
- Created: 2018-01-25T16:29:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T20:11:47.000Z (10 months ago)
- Last Synced: 2024-12-19T21:21:30.011Z (10 months ago)
- Topics: ble, bluetooth, bluetooth-low-energy, drone, mambo, minidrone, parrot
- Language: JavaScript
- Homepage: https://minidrone.js.org
- Size: 2.03 MB
- Stars: 31
- Watchers: 6
- Forks: 6
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Minidrone-js [](https://badge.fury.io/js/minidrone-js) [](https://codeclimate.com/github/Mechazawa/minidrone-js/maintainability) [](https://travis-ci.org/Mechazawa/minidrone-js)
---------------
Minidrone-js is an easy to use drone library for the Parrot
Minidrones. In theory it supports many different Parrot drones
besides Minidrones but this is untested.
This library is loosely based on the work by [fetherston] for
[npm-parrot-minidrone] and [amymcgovern] for [pymambo].
[amymcgovern]: https://github.com/amymcgovern
[pymambo]: https://github.com/amymcgovern/pymambo
[fetherston]: https://github.com/fetherston
[npm-parrot-minidrone]: https://github.com/fetherston/npm-parrot-minidrone
## Functionality
This library is designed to support the two-way command communication
protocol used by Parrot drones. It supports receiving sensor updates
and sending commands based on the [xml specification].
[xml specification]: https://github.com/Parrot-Developers/arsdk-xml/blob/master/xml/
## Installation
```bash
npm install minidrone-js --save
```
## Example
This example will make the drone take-off, do a flip and then land again.
```js
const {DroneConnection, CommandParser} = require('minidrone-js');
const parser = new CommandParser();
const drone = new DroneConnection();
/*
* Commands are easily found by reading the xml specification
* https://github.com/Parrot-Developers/arsdk-xml/blob/master/xml/
*/
const takeoff = parser.getCommand('minidrone', 'Piloting', 'TakeOff');
const landing = parser.getCommand('minidrone', 'Piloting', 'Landing');
const backFlip = parser.getCommand('minidrone', 'Animations', 'Flip', {direction: 'back'});
/** Helper function */
function sleep(ms) {
return new Promise(a => setTimeout(a, ms));
}
void async function() {
await new Promise(resolve => drone.once('connected', resolve));
// Makes the code a bit clearer
const runCommand = x => drone.runCommand(x);
await runCommand(takeoff);
await sleep(2000);
await runCommand(backFlip);
await sleep(2000);
await runCommand(landing);
await sleep(5000);
process.exit();
}();
```
## Troubleshooting
#### MacOS won't connect to the drone
- First turn off Bluetooth
- Run the following code in your shell
```sh
rm -v ~/Library/Preferences/ByHost/com.apple.Bluetooth.*.plist
sudo rm /Library/Preferences/com.apple.Bluetooth.plist
```
- Turn Bluetooth back on
Or alternativly using [blueutil]:
```sh
blueutil off
rm -v ~/Library/Preferences/ByHost/com.apple.Bluetooth.*.plist
sudo rm /Library/Preferences/com.apple.Bluetooth.plist
blueutil on
```
[blueutil]: http://www.frederikseiffert.de/blueutil/
## License
MIT License
Copyright 2018 Mechazawa
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.