Folk Computer

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
Do you want to set up your own Folk system?

**Note: Folk is in a pre-alpha state and isn't yet well-documented or well-exampled.**

**We're making Folk's source code & instructions free and available to the public, in case you're already excited about trying it, but we haven't formally announced it or made it ready for public use. We make no guarantee of support, of usability, or of continuing backward compatibility. Try at your own risk!**

==== Software requirements ====

Folk is open-source software, available to the public under the Apache 2.0 license.

**See [[https://github.com/FolkComputer/folk?tab=readme-ov-file#folk|the README on GitHub]] for software instructions.**

==== Hardware requirements ====

From scratch, we would estimate somewhere between $50-200 per square foot that you want to cover, depending on decisions like what resolution and framerate you want. You may already have a projector and/or webcam and/or computer -- note that you will almost certainly need a dedicated computer running Linux to run Folk, not your laptop.

=== Hardware list for setting up a Folk instance ===

== Computer ==

  * We recommend the [[https://www.amazon.com/dp/B09SYSPSSM|Beelink SER5]] ($300) mini PC or the [[https://www.amazon.com/Beelink-Computer-Desktop-Display-Ethernet/dp/B0BVFXCJ2V|Beelink Mini S12]] ($160) mini PC. An Intel NUC can also work (folk0 at Hex House is a Hades Canyon NUC).

  * <del>For portable installations, a [[https://www.raspberrypi.com/products/raspberry-pi-4-model-b/|Raspberry Pi 4]] (may be difficult to get) or an [[http://www.orangepi.org/html/hardWare/computerAndMicrocontrollers/details/Orange-Pi-5.html|Orange Pi 5]] ($50-100)</del>
    * <del>Note: for these options, you'll also need a microSD card for the OS, microSD card reader, &amp; 5V4A USB-C power supply (often sold separately).</del>
    * <del>The Orange Pi 5 will also require a Wi-Fi/Bluetooth USB dongle ([[https://www.amazon.com/Edimax-EW-7611ULB-Wi-Fi-Bluetooth-Adapter/dp/B01KVZB3A4|example]]).</del>
    * <del>The Raspberry Pi 4 will require a micro-HDMI to HDMI dongle or cable. It can be set up headlessly and automatically.</del>

  * A high-end Raspberry Pi (Orange Pi 5 or Pi 5) can work in a pinch, but computer power matters a lot for latency and user experience, so we recommend investing in a solid computer.

  * (You will probably need a USB keyboard and USB flash drive to get your computer initially set up.)

  * Expect 5-15fps on a Pi-4-class machine and ~60fps on a NUC/Beelink-class machine right now.

== Projector ==

  * We recommend the **[[https://aaxatech.com/store/products/4k1_pico_projector_store.htm|AAXA 4K1]]** (~$800, available refurbished only) or (untested) maybe the [[https://www.lg.com/us/projectors/lg-hu710pb-smart-portable-projector|LG CineBeam Q HU710PB]] for the brightest, clearest text rendering and largest area.

  * If you’re on a budget or want a more portable option, the [[https://aaxatech.com/store/products/P400_mini_projector_store.html|AAXA P400]] ($269) is a good option for a portable 1080p projector.

  * Any projector will do, but any projector with a native resolution of less than 1080p will only be good for projecting shapes & very large text.

  * Ultra-short-throw projectors like the Samsung The Premiere are expensive but can be really bright and may allow you to avoid overhead mounting. It may be difficult to calibrate an ultra-short-throw projector (because it's hard to tilt the calibration board and the optics are really distorted)

== Camera ==

  * Any 720p, 1080p, or 4K webcam may work, but we recommend you get a webcam that has the ability to **set manual exposure** (including any of the below). (This is so that the camera image doesn't get washed out by light from the projector during calibration.)
    * You'll also have a better experience if the webcam can do 60fps at whatever resolution you have set.

    * We would recommend a [[https://www.amazon.com/Microphone-NexiGo-N980P-Reduction-Wide-Angle/dp/B08DHPBP65|NexiGo N980P]] (1080p, 60Hz) or Logitech BRIO 4K (4K, 60Hz).
      * A Logitech C920 series 1080p webcam is often used & is easy to find & affordable, but the [[https://www.bestbuy.com/site/logitech-c922-pro-stream-1080-webcam-for-hd-video-streaming-black/5579380.p?skuId=5579380|Logitech C922]] is probably a better option, because it can do 720p60; the C920 can only do 720p30.
      * (We used to use a Microsoft Azure Kinect, but it can only do 30Hz.)

    * Hang your webcam as close to the table (projection surface) as possible. You want the tags to be as big in the webcam image as possible to help detection stability. (If ceiling mounting, you will probably find that your webcam should be much lower than your projector.)

== Printer ==

  * Any printer will do. If you’re looking for a small printer for your setup, we use the [[https://epson.com/For-Work/Printers/Inkjet/WorkForce-EC-C110-Wireless-Mobile-Color-Printer/p/C11CH25202|Epson EC-C110]] ($339).

  * We're experimenting with receipt printers. We're working on supporting the [[https://www.amazon.com/Printer-Portable-Compatible-Bluetooth-Wireless/dp/B09KZR533K|"cat printer"]] (~$25, available cheaper on AliExpress).
    * You will probably want thermal label rolls and/or tape and index cards, because receipts curl up on their own, which breaks tag recognition.

== Mounting hardware ==

  * [[https://projectorsewing.com/how-to-mount-a-mini-projector-for-sewing/|Projector Sewing]] has useful tips and ideas for mounting.

  * This [[https://www.amazon.com/dp/B000CRDD6Y|quick support tension task rod thing]] ($50) can extend from floor (or at least tabletop) to ceiling in many rooms (160 inches) and can bear 70 pounds of weight.

    * It's probably the most straightforward, general way to mount a projector overhead -- extend the rod and [[https://www.amazon.com/dp/B06VYCVVVJ|clip]]/[[https://www.amazon.com/dp/B00DJ5XH4O|clamp]] projector and camera to the rod at whatever height you want.

  * <del>[[https://www.bhphotovideo.com/c/product/843750-REG/On_Stage_MA125_MA_125_Mic_Screw_Adapter.html|1/4" to 5/8" screw adapter.]]</del>

  * <del>For a portable installation, either [[https://www.bhphotovideo.com/c/product/1540295-REG/samson_samba48_microphone_boom_arm_stand.html/?ap=y&gclid=CjwKCAjww-CGBhALEiwAQzWxOu-g3UOeonw8y3RgrKOl32IqRmzAJFhwXUg-gp0JuU0uuLkcWnVc7RoCdGgQAvD_BwE&lsft=BI%3A514&smp=y|a microphone boom arm]] or a [[https://www.amazon.com/Bluehorn-Portable-Aluminum-Wireless-Shutter/dp/B07K7MSV25/ref=sr_1_8?crid=1IFNZYSFOSDUI&keywords=selfie+stick+tripod&qid=1677347914&sprefix=selfie+stick+tripod%2Caps%2C102&sr=8-8|selfie stick tripod]] (”selfie stick” rather than traditional extending tripod because it takes up less room on the desk) for the projector. Also, use a [[https://www.bhphotovideo.com/c/product/1359603-REG/joby_jb01507_gorillapod_3k_kit.html|flexible mini tripod]] or a [[https://www.bhphotovideo.com/c/product/1695995-REG/zuma_z_amc_1032a_clamp_with_5_8_stud.html|clip with a 1/4” attachment]] to mount the camera on the boom arm/tripod.</del>

==== Support ====

Note: it's very not-turnkey right now; you'll definitely run into bugs and issues. We plan to do a more comprehensive release and announcement, including more examples and explanations, but there's a lot of work to do before then.

We're happy to talk about consulting work if you want dedicated support or system development. Reach out at [[mailto:omar@folk.computer|omar@folk.computer]] and [[mailto:cwervo@folk.computer|cwervo@folk.computer]].