SonixOS

Guide

Getting started

Install

Download r3proii.upt for the R3 Pro II or r1.upt for the R1 from the download page.

Use only the file for your player. The update does not check the model.
  1. Charge the player above 30%. The update does not start below that.
  2. Copy the file to the root of the microSD card and insert the card.
  3. Start the update. From the stock firmware, use its update from microSD. From SonixOS, use Settings › System › Update firmware › From SD card.
  4. The player shows "Upgrading...", then "Succeeded", and restarts.

First start

On the first start, SonixOS asks for the language, then for a Wi-Fi network to set the date, time and time zone. The Wi-Fi step can be skipped; the date and time are then set by hand.

The library is empty until the card is scanned: see Scanning the library.

Updating

Settings › System › Update firmware:

  • Via internet: checks the latest release on GitHub, shows its version, size and changelog, then downloads and installs it.
  • From SD card: installs r3proii.upt or r1.upt from the root of the card.

Files on the card

PathContents
Audiobooks/Audiobooks, in any subfolder. Audiobooks/Author/Series/Book sets author and series when the tags don't.
Podcast/Local podcasts, one folder each. Downloaded episodes and OPML files.
Ebook/EPUB books.
Games/GB/, Games/GBC/Game Boy and Game Boy Color ROMs.
Games/Bios/Optional boot ROMs: dmg_boot.bin, cgb_boot.bin.
PEQ/Parametric EQ presets in Equalizer APO format (.txt), AutoEq downloads included.
Playlist/.m3u backups and playlists to import.
Screensaver/Screensaver pictures.
Bootlogo/Custom boot logos, JPEG or PNG.
radio.txtCustom radio stations, in the root.
.local/SonixOS data and the log. Hidden.

Lyrics (.lrc, .txt) and CUE sheets (.cue) sit next to their track, with the same file name.

Music

Scanning the library

Start a scan from Music › › Scan options › Scan music library, or with the Scan button on an empty Music page. Choose the folders to include; Audiobooks and Podcast are always excluded. Cancel stops the scan and keeps what was already read.

Scan options

OptionEffect
Detect changesAdds and removes tracks at startup, when the card is inserted, and after USB or Wi-Fi transfer. Turned on by the first scan.
Detect changed tracksAlso re-reads tracks whose tags changed.
Do not ignore articlesSorts "The", "A" and similar articles as part of the name.
Split artistsLists a track under each artist in "A & B" or "A feat. B". Separators: ; / & , feat. vs. x + with and.
Split album artists tooApplies the same split to album artists.
Artists not to splitNames kept whole, such as "Simon & Garfunkel".
Split genresLists a track under each genre. Separators: ; / ,.
Join albumsMerges tracks of the same album in one folder, regardless of artist.

Split and join options take effect on the next scan.

Browsing the library

The Music page holds All tracks, Albums, Artists, Album artists, Genres, Years, Favourites, Most played, Playlists and Browse. opens the Music settings, the search. The tiles can be reordered or hidden in Music settings › Library › Rearrange main page.

List buttons

  • Sort: toggles A-Z and Z-A . On All tracks and Albums it opens a menu with name, date added and year.
  • Play all: Play in random order, Play in sequence, Add a random track to the queue. Album lists also offer Play albums in random order when Play albums back to back is on.
  • Disc: on an artist, groups the tracks by album.
  • Reverse: in Favourites, shows the most recent first.

Long lists show an A-Z bar on the side while scrolling; drag along it to jump to a letter.

Search

Results are split into Tracks, Albums and Artists. Hold a result for its menu.

Browse

The folders of the card as they are. A file plays its folder from that point. returns to the root, shuffles the current folder.

Cover Flow

Enable it in Music settings › Library › Cover Flow, then swipe up from the bottom edge of the Music page. Tap the centre cover to show its tracks; drag down to close.

Library options

OptionEffect
Album viewArtists, genres and years open their albums instead of their tracks.
Alternative album viewAlbums open with a large cover and details above the track list.
Show artistShows the artist under the title in the chosen lists.
Audio qualityShows a lossy, CD, Hi-Res or DSD badge.
Go to current trackOpens lists on the playing track.
Allow deleting tracksEnables deleting files from selection mode.

Menus and selection

on a track: Add to favourites, Add to queue, Add to playlist (Remove from playlist inside one), Show album, Details.

Hold a track, album or artist to start selection mode, then tap to add or remove rows. Actions:

  • add to the queue, to favourites, to a playlist;
  • remove from favourites, from the playlist;
  • delete from the card, after confirmation (requires Allow deleting tracks);
  • exit selection mode.

Playlists

  • New playlist creates one. Tracks are added from the track menu, from selection mode or from Now Playing.
  • reorders a playlist; drag the rows by .
  • on a playlist: Rename, Delete, Backup. Backup writes an .m3u to Playlist/.
  • imports .m3u files from the root of the card or from Playlist/. Moved tracks are matched again, and a report lists the result.

Playback

The repeat button cycles through off , repeat all , repeat one , shuffle and continuous shuffle , which reshuffles at every round.

Music settings › Playback options:

OptionEffect
Gapless playbackNo gap between consecutive tracks, Bluetooth included.
Replay gainTrack, Albums, or Track when shuffled.
FadeCrossfade between tracks, 1 to 10 seconds.
Mono audioMixes both channels.
Add to queueInserts tracks Next or At the end.
Continuous shuffleAdds continuous shuffle to the repeat button.
Sleep timerPauses music after the set time.
Play albums back to backContinues with the next album.
Play by folderContinues with the next folder in Browse.
Remember trackRestores queue and position after a restart.
Remember volumeKeeps a separate volume for 3.5 mm, 4.4 mm, USB-C and Bluetooth.

Now Playing

Swipe left from most pages to open Now Playing; swipe right on the cover to close it. The star adds the track to favourites. Drag the progress bar to seek.

Layouts

Music settings › Now Playing › Player layout: Standard, Waveform (the seek bar shows the track's waveform; local files only) or Alternative (a centred cover over a full-screen blur).

On the same page: Cover colour tints the controls with the cover's main colour; Use track artist shows the track artist instead of the album artist; Show Now Playing at startup opens it on boot (requires Remember track).

Menu

: Queue, Add to playlist, Show album, Details, Settings.

Audiobooks and podcasts

Previous and next skip by 10, 30 or 60 seconds; the repeat button becomes the speed control , 0.5x to 2.0x. Audiobooks add Chapters, Add bookmark, Bookmarks and Summary to the menu.

Queue and history

Open from Now Playing › › Queue. The page shows the playing track under Now playing, followed by the upcoming tracks. Tracks before the current one are not listed: what was played is in the history.

ActionHow
Play a trackTap it. Now Playing opens on that track.
Show the historyPull the list down past Now playing. Entries are grouped under Today, Yesterday and earlier dates.
Replay from the historyTap an entry to play it right after the current track, or hold it and drag it to a position in the upcoming tracks.
Reorder, then drag the tracks by .
Remove, select the tracks, then .

The history is hidden while selecting or reordering.

Lyrics

Swipe left on the cover to show the lyrics. Synced lyrics highlight the current line, and tapping a line seeks to it. The screen stays on while lyrics are shown.

Lyrics are read from a .lrc or .txt file with the track's name, or from the tags.

Downloading from LRCLIB

On a track without lyrics, tap Search. SonixOS queries LRCLIB with the title and artist from the tags; if Wi-Fi is off, it offers to turn it on and searches once connected. Pick a result (Synced or Text only) and tap Apply: the lyrics are saved as a .lrc next to the track. searches again.

Sound

Equaliser

Sound settings are in the Music settings: on the Music page, or Settings in the Now Playing menu. Active effects are marked with a coloured arrow. The equaliser, PEQ and MSEB also apply to radio and streaming.

Music settings › Equaliser: ten bands from 31 Hz to 16 kHz, ±12 dB.

  • : built-in presets (Flat, Rock, Pop, Jazz, Classical, Dance, Bass, Treble, Vocal, Acoustic), Save preset, Load preset.
  • resets all bands to 0 dB.

Parametric EQ and AutoEq

Music settings › PEQ: ten bands, a preamp from −15 to +6 dB and the resulting curve. When the curve would clip, the level is lowered automatically and the reduction is shown.

ParameterRange
ShapePeak, Low shelf, High shelf, Low pass, High pass
Frequency20 Hz to 20 kHz
Gain±15 dB (not used by low and high pass)
Q0.10 to 10.00

Tap the Gain or Q value to enter it on a keypad; − flips the sign.

Presets

saves and loads presets, stored as Equalizer APO .txt files in PEQ/. Files with more than ten filters or unsupported filter types are loaded without them, with a notice.

AutoEq

searches the AutoEq database by headphone name (requires Wi-Fi). The selected profile is downloaded, saved in PEQ/ and applied. refreshes the database.

MSEB and effects

EffectDescription
MSEBHiBy's tuning, ten sliders: Temperature, Extended bass, Bass texture, Note thickness, Vocals, Female overtones, Male vocal, Female vocal, Instruments, Air. handles presets and the slider range.
SoundfieldStereo width, from 0 (mono) to 2.
CrossfeedMixes part of each channel into the other. Amount 10–100%, cutoff 300–2000 Hz, delay 0–600 µs.
Channel balanceAttenuates one side by up to 20 dB.

DAC settings

OptionEffect
High gain+6 dB output.
DSD gain compensationRaises DSD by 1 to 6 dB to match PCM.
FiltersFast or slow roll-off, low latency or phase compensated.
NOSDisables oversampling.
DAC DRECS43198 dynamic range enhancement. R3 Pro II only.

DSD is played natively, and converted to PCM when the output does not support it (Bluetooth).

Volume and outputs

FeatureWhere and what
Volume limitMusic settings › Volume limit. Maximum for 3.5 mm, 4.4 mm and USB-C.
Volume stepsSettings › More › Volume steps. 1 to 5 per key press.
Line outControl centre. Fixed level for an external amplifier; requires a cable in the jack. The previous volume is restored when turned off.
USB DACMore › DAC › DAC mode. The player becomes a USB sound card, 32 to 384 kHz. toggles charging.
USB audio outPlays through a USB DAC or USB-C headphones connected to the player.
Online

Tidal and Qobuz

Both are under Streaming and require Wi-Fi and a subscription.

TidalQobuz
Sign inQR code or code at link.tidal.comUsername or email and password; only the session token is stored
QualityAAC 96, AAC 320, FLAC 16/44, FLAC 24MP3 320, FLAC 16/44.1, 24/96, 24/192
LibraryFavourite tracks and albums, My playlists, New releases, Most streamed, RecommendedFavourite tracks and albums, My playlists, New releases

searches tracks, albums and artists. adds or removes favourites and deletes your playlists. Quality and sign-out (Leave) are under .

Radio

Streaming › Radio: stations by Language, Country and Genre, in MP3, AAC and FLAC. Corner buttons: favourites , Recently played , My stations , search . Stations are added to favourites from Now Playing.

My stations

radio.txt in the root of the card, one station per line as name, address. A line in square brackets starts a section; lines starting with # are ignored.

# My stations
[Rock]
My rock station, https://example.com/rock.mp3
[Jazz]
My jazz station, https://example.com/jazz.aac

Podcasts

Streaming › Podcasts: Followed, On the card and Trending. accepts a name or a feed address; follow from , up to 100 podcasts.

  • Episodes are filtered by To hear, All and Heard. Resume listening continues the last unfinished episode.
  • Episode menu: Mark as heard, Play next, Download, or Delete from the card.
  • Hold an episode to select several, then download or delete them together.
  • Local podcasts go in Podcast/, one folder each; title, date and cover come from the tags.

Podcast settings

OptionEffect
Change controlsSkip back and forward amounts.
Stop at end of episodePauses when the episode ends.
Sleep timerSeparate sleep timer for podcasts.
Import from OPMLFollows the podcasts in an .opml file from the root or Podcast/.
Export to OPMLWrites the followed podcasts to an .opml file.
Episode orderNewest or oldest first.
Mark as heard in the last30 s, 60 s or 2 min before the end.

Last.fm

Sign in from Music settings › Last.fm › Account, then enable Scrobble to Last.fm. Plays made offline are queued and sent on the next connection; Waiting to be sent shows the count.

Books and extras

Audiobooks

Books go in Audiobooks/, either as single files with chapters (.m4b, .mp3 and others) or as folders of files, including CD 1, Disc 2 subfolders. Scan them from › Scan audiobooks.

Views: Library, Series, Authors and Continue, each with its own sort order. lists finished books, the bookmarks. The position is saved per book; chapters are read from the file. Playback speed ranges from 0.5x to 2.0x without pitch change. Up to 64 bookmarks per book.

Audiobook options

OptionEffect
Change controlsBack and forward skip: 10, 30 or 60 seconds.
Show durationProgress of the whole book or of the chapter.
Stop at end of chapterPauses when the chapter ends.
Sleep timerSeparate sleep timer for audiobooks.
Rewind after pauseRewinds 3, 5, 7 or 10 seconds on resume.
Scan audiobooksRescans Audiobooks/.

E-books

EPUB 2 and 3 files in Ebook/, opened from More › Books. Vertical Japanese text is rendered vertically.

GestureAction
Tap left or right side, or swipePrevious or next page
Double tap the top of the pageBookmark (up to 64 per book)
Hold the centreReader menu

Reader menu: Chapters; Text (size, line spacing, margins, word spacing); Look (theme Paper, Sepia or Night; page turn Instant, Slide or Vertical scroll); Close the book.

On the shelf, lists bookmarks and configures the reading bar: chapter, progress (book or chapter), page, battery, clock.

Game Boy

ROMs in Games/GB and Games/GBC, opened from More › Gearboy and listed by title.

  • D-pad with diagonals on the left, A and B on the right. Select and Start: a button row on the R1, the bottom corners of the screen on the R3 Pro II.
  • Press the centre of the game screen for Create save state, Load save state, Settings, Quit the game.
  • : palette, shader, GBC colour correction, Show boot ROM at startup (requires dmg_boot.bin and cgb_boot.bin in Games/Bios).

Metronome, files and more

Metronome

More › Metronome: 30 to 250 BPM via −/+, slider or tap tempo; time signatures 1/4, 2/4, 3/4, 4/4, 5/4, 6/8, 7/8; accent on the first beat. Not available while audio is playing.

File manager

More › File manager: the whole card, hidden files included. Images and text files open in place. : Rename, Move to, Copy to, Delete. creates a folder.

Flappy Bird

More › Flappy Bird. Sound can be muted from the title screen.

Wireless

Wi-Fi

Wireless › Wi-Fi. Hold the current network for Details (IP, MAC, signal, security), Disconnect and Forget network; hold a saved network to connect or forget it. rescans.

Bluetooth

Wireless › Bluetooth. searches for devices in pairing mode; new devices appear under Other devices, known ones under Paired devices. : Connect or Disconnect, Rename, Forget.

Bluetooth audio

  • Change name: the name shown to other devices.
  • Codecs: codecs supported by the connected device; the best one is selected automatically.
  • Synchronised volume: links the player and headphone volume.

Bluetooth receiver

turns the player into a Bluetooth sink for a phone or computer. Incoming codec and quality are shown; changes the codec. Headphones must be disconnected first.

AirPods

Wireless › Bluetooth › › AirPods, with AirPods connected: battery of each earbud and the case; noise control with Noise cancellation, Transparency and Adaptive (on supported models). Press and hold sets which modes the stem cycles through; at least two are required.

AirPlay, DLNA and transfer

On the Wireless page. All require Wi-Fi and stay on in the background.

FeatureDescription
AirPlayReceives audio from iPhone, iPad and Mac.
DLNARenderer for DLNA apps. Requires a microSD card.
TransferFile manager in the browser at sonix-transfer.local or the address on screen: upload files and folders, download, rename, move, delete. Playback stops while it is on.
USB storageConnected by cable to a computer or phone, the card is shared as a drive. With Detect changes on, the library updates when it is unplugged.
System

Control centre

Drag down from the status bar to open; drag up or tap outside to close. It contains brightness, the playing track with its controls, and up to 16 toggles; with more than 8, drag the handle under the brightness slider to expand. Tap a toggle to switch it, hold it to open its page.

ToggleTapHold
Wi-Fi, Bluetooth, AirPlay, DLNA, SonixLinkOn / offSettings page
Equaliser, PEQ, MSEBOn / offEffect page
Fade, Gapless playbackOn / offPlayback options
GainHigh gain on / off-
Line OutFixed output level, after confirmation-
Wi-Fi transferOpens and starts transferOpens transfer
Sleep timers (music, audiobook, podcast)Start / stopTimer settings

Toggles are chosen and ordered in Settings › More › Control centre by dragging between In use and Not in use.

Keyboard

Layouts

Settings › More › Keyboard layout. Drag layouts by into In use; the first one is the default. Available: English, Italiano, Deutsch, Español, Français, Русский, Nederlands, Polski, Português, Čeština. The initial layout follows the system language.

With more than one layout in use, hold 123 to switch layout while typing; the choice lasts until the page is closed.

Type

Settings › More › Keyboard type: QWERTY (full keyboard) or T9 (phone keypad with multi-tap). Applies to all layouts.

Input

InputAction
Tap for one capital, double tap for caps lock .
Accented lettersHold the letter and slide to the variant.
123Numbers and symbols; shows the second symbol page.
DeleteHold to delete continuously.
Shows the password in clear.

Buttons and remotes

Settings › More › Remap buttons assigns Play/Pause, Previous track, Next track, Volume up, Volume down or Nothing to each hardware button. The power button is fixed. On the R1, Double click adds a second action on a double press.

InputAction
Hold next / previousSeek in 5-second steps.
Hold PowerPower menu: slide to power off or restart.
Volume up + PowerScreenshot to the card. Requires Settings › More › Enable screenshots.
Volume down + PowerLocks or unlocks the buttons with the screen off. Requires Settings › Power › Lock keys when the screen is off. Power and remote stay active.

In-line remote

Settings › More › In-line remote. One click play/pause, two clicks next, three clicks previous. USB-C headsets with buttons are supported.

Appearance

Settings › Appearance:

OptionValues
ThemeDark, Light.
Clock positionLeft, Centre, Right, Hide.
Accent colourBlue, orange, yellow, green, purple, pink.
Dynamic tintTints the interface with the accent colour.
Boot logoDefault (follows theme and accent) or a JPEG/PNG from Bootlogo/, cropped to the screen.
Text sizeNormal, Large.
Battery percentageShows the percentage in the status bar.
Always show the status barKeeps it visible in Now Playing.
Rounded cornersRounds the screen corners.

Screen and screensaver

Settings › Screen:

OptionValues
BrightnessDown to 1%. Also in the control centre.
Screen off15 s, 30 s, 1 min, 2 min, 5 min, Never.
Double tap to wakeR3 Pro II only.
Rotate screen180° rotation.
ScreensaverAlbum (cover of the playing track) or Pictures (from Screensaver/). Swipe up to dismiss.

Screensaver pictures: baseline JPEG, portrait, at most 480 x 720 (R3 Pro II) or 480 x 800 (R1).

Power and battery

Settings › Power:

OptionValues
StandbyAfter 1, 3, 5 or 10 minutes of inactivity.
Charge limitR3 Pro II: 80–100%. R1: about 80%.
Limit current to 500mAR1 only.
LED on / LED off in standbyFront LED behaviour.
Lock keys when the screen is offEnables the Volume down + Power lock.
Auto power-off15 min to 6 h, only when idle.

With the player off and the charger connected, the battery level is shown; press power to show it again, hold to boot. A warning appears at 5%; at 1% the player shuts down after a 10-second countdown, also from standby.

Date, time and language

Settings › Date and time: Automatic sets date, time and time zone over Wi-Fi; Manual sets them by hand, with time zone and Standard time or Daylight saving. 24-hour clock switches between 24-hour and AM/PM.

Settings › Language: English, Italiano, Deutsch, Español, Français, Nederlands, Polski, Português BR, Čeština, Russian, Chinese, Japanese. Korean, Thai and Arabic titles are displayed in every language.

About and developer options

  • About (Settings › System › About): device, DAC, serial number, card usage, version.
  • Factory reset: clears settings, Wi-Fi networks and Bluetooth pairings. Files on the card are not affected.

Tap Build number five times to enable Developer options at the bottom of Settings: ADB, Log to microSD, database and Bluetooth logs, and Processes (memory use and running processes).

Help

Reporting a bug

Report only features described in this guide; anything else is a feature request. Every bug report needs a log. Logs are written to the hidden .local folder of the card: Cmd + Shift + . shows it in the Finder; on Windows enable Hidden items.

  1. Enable Developer options: tap Build number five times in Settings › System › About.
  2. In Settings › Developer options, turn on the log for the problem (see the table).
  3. Reproduce the problem.
  4. Attach the log file to a bug report on GitHub.
LogWhenFile
Log to microSDAny problem..local/sonix_player.log
Database logCrashes or freezes during a library scan. Requires Log to microSD: the scan writes the name of every file it reads, so the file that causes the crash is the last one listed..local/sonix_player.log
Bluetooth logPairing, connection and audio problems over Bluetooth. Works without Log to microSD. Turn it on, then try to connect the device again..local/bluetooth.log