Skip to content

v1.3-beta

Pre-release
Pre-release
Compare
Choose a tag to compare
@Eeems Eeems released this 08 Sep 05:23
· 320 commits to master since this release
v1.3-beta
b557f05
This commit was signed with the committer’s verified signature.
Eeems Nathaniel van Diepen
GPG key ID: 87F4F19E784573DA
Learn about vigilant mode.

Features Added

  • Application config files can now have comments (lines starting with #)
  • Beginning to work on an API for other applications to interact with. This includes adding a new binary named rot that can be used to interact with it from the command line.

Issues Fixed

  • #36 Wifi toggling will update in the UI much faster
  • #32 If you don't include an imgFile configuration, oxide will now use the default icon.
  • #38 Sort applications by name

Warnings

As part of implementing #38 users have lost the ability to choose what order applications will display. There is a plan to add this back in a future release as part of #11.

Currently, battery/wifi status will be checked every 3 seconds, but the UI should only change if they have changed. I'm not sure how much this will affect performance. Please let me know on the community Discord if you notice that your battery is draining quicker on this version.

By default the clock will use UTC, if you need to change your timezone you'll need to ssh into the device and use timedatectl set-timezone to change your timezone (e.g. timedatectl set-timezone America/Denver). You can see possible timezones by looking in /usr/share/zoneinfo/ (Don't trust the output of timedatectl get-timezones)).

Manual Upgrade

  1. Replace the oxide binary on your device.
  2. Optionally copy the new rot binary to your device.

Automated Upgrade

  1. Run opkg update
  2. Run opkg upgrade

Manual Installation

  1. Copy oxide.tar.xz to your remarkable
  2. Decompress files into one of the following locations
    a. Root filesystem: /
    b. Entware: /opt
  3. If you haven't installed to the root filesystem, copy the oxide.service file to /etc/systemd/system
  4. Edit oxide.service to point it at the correct location of oxide
  5. Reload systemd unit files: systemctl daemon-reload
  6. Disable xochitl: systemctl disable --now xochitl
  7. Enable and start oxide systemctl enable --now oxide

Automated Installation

  1. Add the toltec repository to your entware install
  2. Run opkg update
  3. Run opkg install oxide

Configuration

Configuration files can be in one of the following locations:

  1. /etc
  2. /opt/etc
  3. /home/root/.config

The configuration folder contains the following:

  • draft/icons/ Folder containing .png files that are used by applications.
  • oxide.conf Application configuration file. The launcher will automatically maintain this file.
  • draft/ Folder containing configuration files for every application entry to show in the launcher.

Oxide will search through all three locations when building a list of applications. So be careful not to duplicate files between all the locations as they will show up multiple times in the applications list in oxide.

Configuration files for an application use the following format:

name=xochitl
desc=The standard environment for reMarkable.
imgFile=xochitl
call=/usr/bin/xochitl
term=killall xochitl

Options:

  • name: Name of the application
  • desc: Description of the application, will show on long press.
  • imgFile: Name of the icon to use.
  • call: Command to run when launching the application
  • term: Command to run when button-capture is used to kill the application

Since this format is based off of the configuration format used by the draft launcher, you can leave entries blank by either omitting them from the file, or setting them to :, or leaving them blank.

Usage

Oxide consists of three applications: the main launcher, the background service, and the process manager.

oxide - Launcher

After you have configured and launched oxide you can access the power menu from the power button on the top right of the screen. This will allow you to put the device to sleep, or to power off the device.

The menu button on the top left side of the screen will open up the tools menu. This allows you to either refresh the grid, or to open up the options dialog.

Tapping on the wifi icon will toggle wifi on/off.

The options dialog will allow you to configure various settings in the application. You have the option to reload the settings from the conf file on disk, or to close the options dialog and save the current settings to disk.

button-capture - Background service

Press and hold the left button for 1 second or longer to execute the contents of /tmp/.terminate. Oxide will automatically populate this file when launching an application with the term setting.

Press and hold the right button for 1 second or longer to create a screenshot at /tmp/fb.png. It will then execute /tmp/.screenshot if it exists. Due to how the reMarkable preserves colour information in the framebuffer used to generate the screenshot, there may be colour in the screenshots that are not visible on the reMarkable itself.

Press and hold the middle button for 1 second or longer to launch the process manager.

erode - process manager

  • There is a reload button on the top right of the screen that will refresh the list.
  • You can click on the column headers to sort the list by that column.
  • If you click on a kill button for a process you will be prompted on if you really want to kill the process. In that prompt you will have the option to kill the process (SIGTERM), or to force quit (SIGKILL) the process.
  • In order to return to the previously running application you can quit out of the process manager by pressing the left arrow button on the top left of the screen.
  • If the process list is long enough, you can scroll it by swiping up or down on the list. After you have swiped the list will scroll.

rot - CLI API tool

  • Usage from the command line only, run rot --help to see possible options. Currently about all you can do is rot battery get state and rot battery set state 1 which does nothing other than prove that the D-Bus interface is working.
Assets 3
Loading