sunbox / ptp.js

Library for controlling cameras via PTP/IP

Introduction

ptp.js is a JavaScript library providing limited functionality for controlling cameras via PTP/IP: Picture Transfer Protocol via an IP-based network

The first version of the library was developed by Felix for interfacing with a Ricoh Theta. On Firefox Marketplace you find the result: Theta Control

An inspiration was ThetaShutterProc.c, a set of C functions part of ThetaShutter_PQIAirPen002.zip by MobileHackerz. ptp.js has a different architecture, however, making use of JavaScript’s functional nature.

Documentation

Basic usage:

1. Load the module, depending on platform:

   • B2G (TCP Socket API): AMD module scripts/ptp.js

   • Node.js module

   An object is created, let’s call it ptp.

2. Interface with the camera via properties such as ptp.host and functions such as ptp.connect().

For an example, see demos:

• B2G: Firefox OS app (manifest.webapp)

• Node.js: node_demo/app.js

  Note for Windows users: Due to Node.js issue #3584, output may be missing when using redirection, for example with more.

Limitations

• Incompleteness: Many PTP functions are missing.

• Only tested with one camera, the Ricoh Theta.

Development

Module graph as of 2014-06-19 CEST

Module graph created with madge --image graph.png --exclude "util|logger|connection-settings" --format amd scripts, then annotated:

Coding conventions

• Code needs to validate with JSLint.

• Comments are in Markdown.

• Don’t use constructors: JavaScript is a classless language.

• Don’t throw exceptions. JavaScript is a weakly typed language, allowing functions to return different types of values, including types indicating errors.

• Version numbers: major.minor.patch

Publishing a new version

• Keep version up to date in:

  • Git tags

  • package.json

• Publish to:

  • github.com/feklee/ptp.js

  • npm: package ptp

Reading

• 2000-07-05 PTP specification

• gPhoto PTP/IP documentation

• White Paper of CIPA DC-005-2005 (PTP/IP)

License

Except where noted otherwise, files are licensed under the MIT License.

The MIT License (MIT)

Copyright (c) 2014 authors of ptp.js

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.