Skip to content

wisnc/rsvp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rsvp


Rapid Serial Visual Presentation - an ebook reader for the m5cardputer


home screen

read screen


Building

git clone https://github.com/wisnc/rsvp
cd rsvp
pio run

Installing

Just flash it with any launcher. or from the M5Burner.

Check releases for the latest binary

or shameless plug

How to use

your SD must have the file structure for ebooks as

/ebooks/
├─ BookName1/
│  ├─ read.txt
│  └─ prog.txt
├─ BookName2/
│  ├─ read.txt
│  └─ prog.txt
├─ Sample_Book_A/
│  ├─ read.txt
│  └─ prog.txt
│
└─ascii-auto.py

read.txt should contain the entire book in text file. each word will be separated by either a newline or space prog.txt should be 0 for no progress. the value refers to the amount of characters already read as progress

running ascii-auto.py through python or micropython run('ascii-auto.py') will automatically convert all your characters to ascii-printable and direct equivalent

easiest way to convert to .txt is through https://convertio.co/epub-txt/ otherwise use the epub2txt.py from the project

Up - faster wpm

Down - slower wpm

Left - previous word

Right - next word

plus (+) - brighter display

minus (-) - dimmer display

backspace - exit to home

space - pause/play rsvp

ctrl - pause/play rsvp, for left hand

BtnG0 - pause/play rsvp for all hands

p - show/hide peripheral words on the rsvp

ASCII conversion

as you know, the default encoding or font of the cardputer is limited by ascii printable. so books that contain UTF-8 characters cannot be displayed, provided on this repo is a script that can easily convert all the characters in your text to alternative characters that can be displayed by the cardputer

cd ebooks
python ascii-auto.py

run this command in /ebooks/

this script checks out all directories beside it and converts all .txt

fun fact! you can run this python script on micropython within the cardputer. use a micropython firmware

Version History / Changelog

2.3

  • added more keys for pause

2.2

  • added peripheral words feature

2.1

  • persistent settings

  • start on pause

2.0

  • massive change on the UI

  • upload python tool

1.0

  • Public release
  • GitHub repository created

About

Rapid Serial Visual Presentation - an ebook reader for m5cardputer

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors