Skip to content

Typescript library for controlling DJI Osmo Action 3/4/5 and Pocket 3 using BLE (Bluetooth Low Energy)

License

Notifications You must be signed in to change notification settings

datagutt/node-osmo

Repository files navigation

node-osmo

Typescript library for controlling DJI Osmo Action 3/4/5 and Pocket 3 using BLE (Bluetooth Low Energy)

Features:

  • Pairing
  • Connecting to Wi-Fi
  • Selecting resolution, FPS, bitrate and stabilizer mode
  • Going live to a specified RTMP server
  • Getting battery percentage

Getting Started

This project is intended to be used with the latest Active LTS release of Node.js.

Documentation

For usage examples, please check the examples folder. Proper API documentation is coming at some point.

Known issues

BLE (noble library) acts differently on each platform. I have not got this library fully stable yet. PRs are welcome.

Available Scripts

  • clean - remove coverage data, Jest cache and transpiled files,
  • prebuild - lint source files and tests before building,
  • build - transpile TypeScript to ES6,
  • build:watch - interactive watch mode to automatically transpile source files,
  • lint - lint source files and tests,
  • prettier - reformat files,
  • test - run tests,
  • test:watch - interactive watch mode to automatically re-run tests

Thanks

This library would not be possible without these great people and projects:

  • Spillmaker - Initial reverse-engineering of the protocol
  • Moblin - Implementation was highly inspired from this project

License

Licensed under the MIT License. See the LICENSE file for details.

About

Typescript library for controlling DJI Osmo Action 3/4/5 and Pocket 3 using BLE (Bluetooth Low Energy)

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published