16mm
/
intval3
1
0
Fork 0
Code Issues 1 Pull Requests 9 Projects Releases Wiki Activity

Create both readme files, one at the project level and another just for the mobile app. More work needed on the project one.

This commit is contained in:
mmcwilliams 2018-02-07 18:22:28 -05:00
parent 8ec1694b02
commit e8eec95107
2 changed files with 59 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
Readme.md
View File

@ -10,12 +10,39 @@ The [INTVAL2](https://github.com/sixteenmillimeter/intval2) project should be us
### Components
* Firmware for the Raspberry Pi Zero W running on [Node.js](https://nodejs.org)
* Mobile/Web/API for controlling device, using [Cordova](https://cordova.apache.org/) + [Bleno](https://github.com/sandeepmistry/bleno), and [Restify](http://restify.com/)
* [Firmware](#firmware) for the Raspberry Pi Zero W running [Node.js](https://nodejs.org) on Raspian
* [Mobile app](#mobile) for controlling device using [Cordova](https://cordova.apache.org/) + [Bleno](https://github.com/sandeepmistry/bleno)
* [Web app](#web) for controlling device using [Restify](http://restify.com/)
* Hardware files, parts models for 3D printing, laser cutting and CNC
* PCB design for a Raspberry Pi Zero W Bonnet
* [Parts list](#parts-list)
<a name="firmware"></a>
## Firmware
The firmware of the INTVAL3 is a node.js application running on the Raspian OS intended for installation on the Raspberry Pi Zero W.
<a name="mobile"></a>
## Mobile App
The INTVAL3 mobile app controls the intervalometer over Bluetooth. It can be used to configure the settings on the intervalometer such as exposure length, delay between frames and the direction of the film. The app can also be used to trigger individual frames, as well as start and stop sequences. As an experimental feature, film exposure settings can be determined with the camera on a mobile device.
<a name="web"></a>
## Web App
As a function of the firmware, there is an embedded web application that is hosted on the INTVAL3. When connected to a wifi network (via the mobile app) users are able to control the intervalometer from a browser. Users are also able to trigger functions and change settings on the intervalometer firmware from the command line by using cURL or wget, so actions can be scripted and automated from an external machine.
<a name="hardware"></a>
## Hardware
All of the non-electronic hardware is generated from OpenSCAD scripts and built into either STL files for 3D printing or DXF files for laser cutting or CNCing.
Electronics designs are available in the form of a Fritzing file, a wiring diagram and a mask image that can be used to fabricate a board from a blank PCB. One of the easiest ways to
<a name="parts-list"></a>
## PARTS

30
app/Readme.md Normal file
View File

@ -0,0 +1,30 @@
# INTVAL3
## Mobile App
The INTVAL3 mobile app is built using the Cordova framework for cross-platform deployment to iOS and Android.
## Requirements
* node.js
* npm
* Cordova
* XCode (for iOS) and/or
* Android Studio (for Android)
## Installation
All of the required plugins can be installed directly by executing the `install.sh` script on a system which supports bash. This script will use the `cordova` application to install the Cordova plugins. Cordova also supports the npm package.json format, so plugins may be alternately installed simply by running a `npm install` command from within the `app` directory.
## Building
Once all dependencies and plugins are installed, you can build the INTVAL3 app by running
```cordova build ios```
or
```cordova build android```
This generates the application source code in the `platforms` directory, under either the `ios` or `android` directory depending on your build target. The app can be built and run on your device by going to the project file and opening it in your IDE, either XCode or Android Studio. Alternately it can be run on your device using the `cordova run ios` or `cordova run android` commands.