https://github.com/gyroflow/flowshutter

Firmware for FC based gyro logger device
https://github.com/gyroflow/flowshutter

camera esp32 flowbox flowshutter gyroflow gyrologger hacktoberfest hacktoberfest2022 micropython motion-logger sony-camera

Last synced: about 2 months ago
JSON representation

Firmware for FC based gyro logger device

• Host: GitHub
• URL: https://github.com/gyroflow/flowshutter
• Owner: gyroflow
• License: other
• Created: 2021-12-24T01:16:11.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-10T06:17:00.000Z (over 2 years ago)
• Last Synced: 2025-04-07T07:42:50.428Z (2 months ago)
• Topics: camera, esp32, flowbox, flowshutter, gyroflow, gyrologger, hacktoberfest, hacktoberfest2022, micropython, motion-logger, sony-camera
• Language: Python
• Homepage: https://docs.gyroflow.xyz/flowshutter/flowshutter/
• Size: 17.6 MB
• Stars: 167
• Watchers: 4
• Forks: 13
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![](images/flowshutter.png)



  Homepage •

  Documentation •

  Discord •

  Report bug •

  Request feature





  

    

  

  

    

  

  

    

  

  

    

  

    

    

  

  

    

  

    

    

  

    

    

  



**Flowshutter** is a custom camera remote. When used in conjunction with readily available hardware, this results in a flexible and reliable external camera motion logger for Gyroflow. It can provide precise synchronization of camera video recording and motion logger (betaflight/emuflight FC) recording. 

**Flowshutter** aims to make all cameras ready for stabilization with [Gyroflow](https://github.com/gyroflow/gyroflow) software to provide you with one of the best open-source video stabilization experiences.

## Features

Flowshutter has the following features:

- '1-click' - (1) start/stop camera recording and (2) arm/disarm FC, via one click 

- Camera recording start/stop control

- FC arm/disarm control

- FC blackbox flash chip erasion

- OLED display

with many more features on the way!

## Hardwares

### Basic View

![](images/basic_inner_structure.png)

### Supported Hardware

Currently we are wroking with NeutronRC for a small range of sales in China. Subsequent versions are in production, please stay tuned.

![NeutronRC SDB](https://user-images.githubusercontent.com/31283897/167240748-b82fc3fc-d208-40f8-b3eb-7423204c46a4.jpg)

At the same time you can try to DIY your own flowshutter hardware. We have two open sourced designs:

- [Credit card sized design](https://oshwhub.com/AirFleet/xiang-ji-kong-zhi-ban):

[![build](images/flowshutter-credit-card-sized.png)](https://youtu.be/ELaQPYE9ncA)

- [FC sized design](https://oshwhub.com/AirFleet/xiang-ji-kong-zhi-ban_copy_copy): 

[![build](images/flowshutter-fc-sized.png)](https://youtu.be/ry7Ey54Z7s8)

### Compatible camera protocol/trigger mechanisms

- [x] Sony MULTI Terminal protocol

- [x] Momentary Ground

- [x] 3.3V Schmitt trigger

- [x] ZCAM UART protocol

- [x] Sony LANC protocol *

- [ ] 5V Schmitt trigger (WIP)

- [ ] HDMI CEC protocol (WIP)

For more information about support camera list, please check the [list](https://docs.gyroflow.xyz/flowshutter/clist/) on the [documentation website](https://docs.gyroflow.xyz/).

_*Note:_ We need an extra Arduino board to send the Sony LANC protocol, triggering mechnism is based on momentary ground, but needs to add opto-coupling module between arduino and flowshutter to prevent overvoltage.

### Compatible FC

FC is short for flight controller, more specifically with betaflight/emuflight running on.

- flowbox (highly recommended)

- modern FC with BMI270 gyroscope (recommended)

- any other FC that support CRSF protocol

## Development Guide

### Flash micropython firmware

The micropython firmware we used is [v1.19.1](https://micropython.org/resources/firmware/esp32-20220618-v1.19.1.bin), You can find a copy in the `/tools` directory. Also, a `uPyCraft` windows version is also provided in the `/tools` directory. You can try to use that to flash your ESP32 without the help of ESP-idf.

### Set up debug environment

Pre-requisite:

- Python3

#### Visual Studio Code with Pymakr extension

1. Install `node`

2. Install `Visual Studio Code`

3. Install `Pymakr` extension in `Visual Studio Code`

4. Edit `address` in `pymakr.conf` to your flowshutter's COM port

5. Pull flowshutter code from `https://github.com/gyroflow/flowshutter`

6. Then you can connect and upload the flowshutter code

#### Thonny IDE

TBD

### Start debugging

1. Modify the `pymakr.conf` to match up with your flowshutter's COM port

2. `python build.py debug` to prepare the debug environment (move modules to `/obj` directory)

3. Upload all modules to the hardware and reboot it.

Note:

- `python build.py debug`: copy modules to `/obj` directory

- `python build.py debug clean`: clean the `/obj` directory. Useful when you are suffering from memory leak.

### Compile flowshutter firmware (single bin)

There's a CI that can help us to this. For compiling it locally, please check `build.py` for more information.

## License

This project is licensed under:

- CC-BY-NC-ND 4.0

- AGPL 3.0

**Note:** AGPL 3.0 is only avaliable after you signed our CLA.

This software is provided as is, and please feel free to use this on your own camera which will be used for shooting/recording comercial images/videos. Please contact [DusKing1]([email protected]) if you intend to use it for other commercial purposes.

## Pillar of shame

**Due to egregious abuse of open source in Wuxi, China, this project refuses to provide any support to any user in Wuxi, or to cooperate in any form with any company or individual in Wuxi. Please do something worthy of your conscience.**