Config.txt File

From Sharpfin
Jump to: navigation, search

Introduction

Radios have a configuration file, which is named ConfigXXXX.txt, where XXXX is the hardware number of the radio, which you can find with 'Configure / Version'. For example, an IR-100 is 1012. The Radios page has known hardware numbers.

The configuration file can be changed to enable/disable certain features. Some of these may add a feature a particular user finds useful. For example, those using the alarm clock may prefer it to be higher in the menu structure, or the history feature might be useful to get back to a recent stream.

In addition to enabling / disabling features, the configuration file also tells the radio which software modules to load. These include network drivers, lcd display drivers etc... If you change these entries, it is possible that your radio will be unable to boot / unable to start the network / unable to display things on the lcd display. please DO NOT simply copy another config.txt file over the top of yours, hoping that your radio will take on the features of another manufacturers - the answer is that it will, including trying to load the wrong drivers

Apply the sharpfin patch, see Enabling Login
Basic concepts and introduction, see Changing Your Radio
  • Log into the radio using telnet (user & password = admin)
  • Look in('chdir /root/hwconfig/') /root or /root/hwconfig, depending on the current firmware version of your radio
  • Find your configxxxx.txt file (The xxxx is the Hardware Id, which you can find in 'Configure / Version')
  • Look in it and others in the same directory to work out what modifications you wish to make (such as enabling alarms)
  • Issue the command 'mount / -orw,remount' to unprotect the partition
  • Edit the configxxxx.txt file with 'vi configxxxx.txt'
  • 'i' to enter Insert mode
  • Double Check your edits
  • Now treble check them!
  • Hit <ESC> to leave Insert Mode and enter Command mode
  • ':w<ENTER>' To write current file (if you are sure and wish to save it)
  • ':q!<ENTER>' To exit 'vi'
  • Write protect the drive with 'sync;mount / -oro,remount'
  • Reboot the radio

Config Overriding

The radio application (ir) has the ability to make ammendments to the configuration dynamically. Basically what happens is that on launch, the file /root/config/DSCO_ConfigOverride.txt is downloaded by a function in dynconfig_override.c and created (if it does not already exist). The ir application then exits, and it is left for the operating system to re-launch it.

For more information on this file, see the Config Override page.


Example Config Files for different Radios

Click here config_example_files for example config files with comments and add your config file if it's missing.


Comments on the Config.txt file

Simbo has provided a list of lots of the Configuration Variables here: Config_Options_List

Space for commented config.txt file (can others add information as it is known and relevant comments please )


Confirmed edits to /root/hwconfig/config1012.txt on a Logik IR-100:

Option:
stations-history
on

Option:
history-size
20

...shows the last 20 streams listened to. History info gets stored in: /root/config/PRE_history.ini, and persists after a power cycle.

NOTE: I tried adjusting the value to 99, with no apparent ill effects with FW.257-a-421-a-057, the file has added a couple of stations quite happily. I know it is a bit of a jump, but might it be possible for Sharpfin to use this file, or another in the same part of the device, as an on board directory of 500 or so popular stations?

Option:
stations-substring-search
on

...Adds 'SEARCH' to the stations menu, allowing searches for stations via letters of the alphabet.(m0aur)

Option:
sleep-timer-upper-limit
86400

...increases sleep timer to a maximum of 24 hours. Value in seconds (M0AUR).

Option:
sleep-timer-increment
300

...Adjusts sleep timer increments in seconds. 300 secs = 5 minute increments.

Option:
standby-text
YourTextHere

...replaces the 'Reciva Radio' text in standby. Use of UTF-8 encoded text in the private which is defined as special symbols in the reciva LCD driver (published by reciva as part of the GPL kernel source) is known to brick the radio. Other non-ASCII text may also have this effect, and there may be a length limit, so you should have a backup strategy before venturing beyond simple short ASCII sequences. 'Internet Radio' which is 14 charaters is OK. DO NOT APPLY STANDBY TEXT EDIT TO MAGICBOX IMP ADAPT TO REPLACE 4 LARGE CLOCK CHARACTERS, IT WILL BRICK THE RADIO! (m0aur)

Option:
clock-in-config-menu
on

...adds Clock in Configure. - Did not appear when used with Firmware v. 257-a-421-a-057 Showing here with FW 257-a-421-a-057 Simbo99 22:58, 20 January 2008 (CET)

Setting this string to OFF places the alarm and sleep functions on the top menu.

Option:
clock-dst-menu
on

...adds DST(„Daylight Saving Time“) On/Off to Clock menu.

Option:
clock-format-menu
on

...lets you change from 24hr to AM/PM - Clock will default to 24hr if there is an active alarm.

Option:
stereo-mode
stereo

Option:
stereo-mode-menu
on

...this adds a Stereo menu in Configure with Stereo/Mono options.

Option:
aux-menu
on

...this adds the menu option Equalisation under Configure & with Treble -14/+14 and Bass -14/+14 - it did nothing to the treble/bass on an IR-100 & IPdio (962).

Option:
contrast-menu
on

...adds the menu option Contrast under Configure & counts up/down with the wheel, doesn't alter the contrast on an IR-100.

Option:
volume-control
on

Option:
initial-volume
28

...whilst listening to a stream, the wheel alters the volume with an on-screen graphic to indicate min/max Volume. Not much use on an IR-100 - which has the audio-amp volume knob. - Easiest to use with 'official' volume control at maximum and use select knob only - NOTE: This leads to a slightly audible background crackle even at low volumes.

I believe the 'initial-volume' refers to the volume of the alarm, changing the value does not appear to have any effect on an IR100 with 257-a-421-a-057 FW.

The initial-volume is the software-volume level when the radio comes out of standby.Simbo99 22:58, 20 January 2008 (CET)

I have tried initial-volume values from 28 to 99 on both the LOGIK IR100 and the Tangent Quattro, Both radios still come out of standby at the last used volume level. Despite the scroll wheel showing a varying volume graphic on the Tangent Quattro, it does not actually alter the volume. (M0AUR)

Volume control displays graphic on Revo Pico but does not behave as expected. Volume is not affected unless 0 is selected which mutes the radio --Goldstien 15:39, 24 June 2008 (CEST)

( Please edit / add more configuration options as known )

From "grepping" through the configxxx.txt

Option:
alarm-clock
off|config1|config2|no-alarm

off: no clock at all, no-alarm: just a clock, no alarm. config1&config2: alarm clock functionality enabled, difference between settings not yet known. 'config1' = alarm goes straight to radio without buzzer (IR100 257-a-421-a-057)


Option:
number-of-alarms
5

This allows you to set multiple alarms and choose weekdays, weekends etc and whether to use the buzzer or a preset - NOTE - Any selected preset must remain tuned to the same channel for the alarm to continue to tune to radio - NOTE - All alarms start with a buzzer, which sounds for 20-30 secs and then tunes to a chosen station, which as to be selected from the 5 presets - Can be switched at will by pressing the Select knob. Buzzer can be disabled by using the alarm clock/config2 hack above.

Increasing the number of alarms in the config1012.txt file of the Logik IR100 running the latest 057 service pack will no longer work, as upon station update, the Reciva site edits the value back down to 2, which is now standard. I think it is done via a 'watchdog s3c2410' command within the /mnt/ramfs/tmp/config1012.txt config1012.txt.withparams. It can also be found in the /mnt/config/DSCO_ConfigOverride.txt, and the /root/config/DSCO_ConfigOverride.txt files. These all seem to link to the /proc/s3c2410-break-hack file. So Reciva seem to be actively blocking some edits. (M0AUR)


Option:
power-on-select-key
on

This allows a select spinner press to turn the radio on. Does not work on Tangent Quattro.


Option:
menu-timeout
10

This controls how long a menu is shown before dropping back to the now playing screen


Option:
back-as-menu-item
on

Adds a <<Back option to every menu


Option:
presets-as-menu-items
on

This shows Twelve presets in "Stations" list. To store a station on any of the presets: Listen to a stream, go (back) to "Stations", scroll to an empty preset, long press on the select spinner - station stored. To listen to a station on these new presets: From "Stations", scroll to desired preset then short press select spinner.


Option:
off-in-main-menu
on

This shows an off option at the bottom of the main menu

Option:
long-select-action
popup

This enables an equalizer menu accessed with a long press of the Select button - Note this is visible but completely non functional on the IR100.


 Option:
 snooze-key
 power

This option produces a 5min snooze on the alarm when you press the power key, I guess it could be mapped elsewhere, the alarm time shown in brackets advances 5 mins to confirm,

IR100 - FW v.257-a-421-a-057 - This works, but makes switching off by the power button rather difficult - the radio seems confused as to what it is supposed to do, press once and sound will break up for about 30secs before powering down.

I also detected a change in the level (up) of the transformer hum while trying this one.

 Option:
 force-metadata
 on

Depending on the station/stream etc, you get track and artist information as a scrolling line - directly after the "REAL ENABLED" it will read something like "REAL ENABLED - xxxx artist - xxx track" This is totally dependent on the stream/podcast station and what they decide to transmit.


Option:
show-busy-bar-on-samba-scan
on

Shows a busy-bar instead of filenames as samba scans a share for media.

Option:
acpoweron-state
network

...on AC power on, radio connects to network then goes to standby, staying connected to network. Only works if "Go to standby after power cycle" under 'My Radios' on the Reciva site is *unticked*. This option is good in the event of an overnight power cut, it stops the radio connecting to the last played station upon reconnection.


Option:
dynamic-mute
off

...(Can someone else try this & confirm then delete/edit this text - taa Simbo99) Keeps the audio amp powered on, so doesn't chop first few seconds of MP3s. Makes Modifying time delay when starting a track redundant?

Cannot comment on mp3s from PC, but it does look like it works! I logged onto an MP3 stream which plays a set file (beatlesradio.com) before you get the stream and for the first time, had the whole thing! (Tried on two IR100s with 257-a-421-a-057 FW.). A comment on the discussion list from "JohnR" suggests that this is not a total fix; it alters things, but there is still a loss of a few seconds at the start of tracks from a Twonky media server (which does not have the delays when used to other devices).

I noticed this problem with Twonky (it would miss off the first 15 secs of each track. I then tried TVersity and this seems to work perfectly (just need to set the Media Playback device as "Windows Media Center").

BAD news about this one, IR100 FW 257-a-421-a-057 - after a couple of days, I noticed a background crackling, which I could not put up with, after editing this config out, it dissapeared, It is worse when the radio is silent, for example when searching for media,butseems to be there all the time, also very noticable on Radio 4, which seems to have a hiss of its own as well. The problem was worse on one radio than the other, so some may possibly not have it at all. I don't know much about electronics, but my best guess is that the config was set up in the original way to hide a quality control issue at the factory.

I noticed this crackling on an unmodified IR100 when listening to quiet audio (eg Radio 4 or Radio 3). I then noticed that the crackling sound corresponded exactly to the activity light on my WiFi access point - it was the WiFi dongle impacting on the speaker (like the transformer hum problem). I moved the dongle to the other side of the radio and this removed the crackling noise. The above config mod works a treat .... I've been using my IR100 with TVersity to listen to audio from my PC and the 'dynamic-mute off' has cured the 3 second mute at the start of each track. Good work you guys.

When turning dynamic-mute off, you can no longer mute your radio with the mute button on the remote control (applies at least for ipdio Style)


Option:
long-browse-press-clears-media-queue
on

...While streaming media from a PC, this allows you to clear the media queue without having to go back up the menus. Very usefull if you stream media!

Option:
hierarchical-locations
on

Organizes the station browser into the not very loved 'continent' order. Answer: Is there a change on the IR100?--Tim 20:12, 22 January 2008 (CET) - If you are running FW v.257-a-421-a-057, which misses the continent step out rfcvb72 19:19, (GMT) 22 January 2008

Option:
preset-poweron
on

Any preset switches on the radio from standby, but infuriatingly only opens the top menu, so pretty much useless until someone can work out another command (if there is one) to make it tune straight to the desired station. (IR100 v.257-a-421-a-057)

Option:
scrobbling
on

No effect at all on and IR100 v.257-a-421-a-057 , but no harm either. I think that this may be intended for devices which include an ipod dock, as LastFM features 'Scrobbling' of ipods.

Option:
deemphasis-menu
on

Option:
deemphasis-menu-values
0 44100

This adds a 'Deemphasis' item to the Configure menu, with the settings of 'none' and '44.1kHz'. Using the above values on the Tangent Quattro, produces a deemphasis menu which contains the options 'None' '32kHz' '44.1kHz' and '48 kHz'. (M0AUR)18:46 8th Feb 2008.

Why would you do this you might ask? Well there's a bug somewhere, maybe in the driver for the Wolfson WM8721 DAC. The de-emphasis register in the DAC is being written to somewhere, and going into this menu and selecting 'none' clears the register and turns off de-emphasis which should not be on in the first place. De-emphasis is something DAC chip makers provide for compatibility with a handful of very early CDs that had pre-emphasis (a treble boost) applied. De-emphasis causes a massive treble reduction and should not be on! According to the DAC data sheet, with it on, the treble is down nearly 10dB at 20kHz which is like turning the treble right down on your amp. The makers of the Logik sets, Hip Shing, (over)compensated for this in the IR-100 with a treble boost in the amplifier so nothing needs to be done here (unless you want a treble boost control) BUT they didn't bother on the IRMA1 which sounds hopelessly muffled. With this tweak in config997.txt it sounds absolutely fine. The only bad thing is I haven't found out how to set a default. If you power-cycle you have to set it again (though from Standby you do not so not a big deal). There is a 'deemphasis-frequency' option too, which I tried setting to '0' but it had no effect. Tested on IRMA1 and IR-100 both with v257-a-421-a-057. Stolen from config854.txt. --GSUM 18:51, 27 January 2008 (CET)

Option:
super-scrolling
on 

Option:
super-scroll-remote-start-delay
2

Option:
super-scroll-remote-scale-factor
1

Option:
super-scroll-remote-max-step-rate
10

Option:
super-scroll-remote-repeat-threshold
400000 

This is VERY handy for the IRMA1 which lacks a rotary selector. (config997.txt) Scrolling through hundreds or even thousands of stations by just holding the << or >> buttons down is impossible - you just lose the will to live. With these options, if you hold the button in for a couple of seconds, it starts leaping 10 entries at a time. Makes the unit MUCH more usable! Tested on IRMA1 with v257-a-421-a-057. Stolen from config854.txt. --GSUM 18:51, 27 January 2008 (CET)

Option:
reset-clock
on

This adds a 'Reset Clock' option to the clock menu, it appears to force a sync with the time server. IR100 with v257-a-421-a-057 (Unofficial)

EDIT: The manual for the Sangean (which has this feature as standard) infers that this function removes any user alteration (DST changes etc) but does not specifically mention resync with the server.


Option:
usb-thumbdrive
on

Option:
thumbdrive-power-connector
2

Option:
thumbdrive-power-pin
30

Option:
local-media
on

...Adds 'Local Media' in 'Media Player' menu. Plug in a thumb-drive with media on it, then power-cycle. Suggest: Add an external USB hub & velcro it to the back of your radio. Just like [this picture]

Option:
media-player
off

Removes the 'Media Player' link from the main menu - obviously this will make the media streaming function useless as well.

Option:
reply-button-exits-spinner
on

In the scrolling character entry lists, for instance when entering a WiFi key, this allows a press on Reply instead of scrolling to the [END] option and selecting it. This is probably part of the default configuration for your radio, but was needed to restore this function with the 257-a-744 beta firmware.



The following settings have only been tried in 257-a-756-a-199 beta firmware....


 Option:
 pbch-report-enabled
 off

Removes the "REAL ENABLED" text from the stream information


 Kernel Module: reciva_lcd_generic line1frame1="Radio" line2frame1="powered" line3frame1="by" line4frame1="sharpfin"  line1frame2="Keep on" line2frame2="rocking" line3frame2="in the" line4frame2="free world"

Replaces the "Reciva Radio" and "ARM powered" startup text. DO NOT simply enter "" as this causes a startup failure, use " " for a blank line.

Changes to /root/hwconfig/all_radios.txt

Most if not all models seem to refer to this file in their main config, so it's contents are presumably referenced as if they were in the main configxxx.txt

Option:
reply-button-function
on

Pressing the reply button when tuned to a stream calls up an add to favourites menu, which adds the stream to 'My Stations' on the radio and your Reciva account.

It may work if you place it in the main configxxx.txt for your radio, but I have not tested it.

Tested on a IR100 with v.257-a-421-a-057 firmware, the text was already there, I just had to change the instruction from 'off' to 'on'

The only radio I know of with this feature as standard is the Tangent Quattro with up to date firmware.


Suggested combinations for various radios

The following known to work well and provide sensible User Interface benefits to Radio owners:


IR 100 with firmware 257-a-421-a-057 (Can someone enter a set of sensible suggestions ?) ^

Max:
clock-dst-menu:on | back-as-menu-item:on | number-of-alarms:5 | alarm-clock:config1 |  
back-as-menu-item: on

"number-of-alarms" is very useful


Rfcvb72 - IR 100 with firmware 257-a-421-a-057 - I have these mods running on two IR100's at the moment
clock-dst-menu:on | back-as-menu-item:on | number-of-alarms:5 | alarm-clock:config1 |  
back-as-menu-item: on | off-in-main-menu: on | stations-history (20)| power-on-select | dynamic-mute: off | 

And in /root/hwconfig/all_radios.txt:

reply-button-function: on

The only problem I have had is with the snooze function on the power button, which caused shutdown problems, might work better if mapped to another button, but then if you cant find the button, why have a snooze function?

Favourites are: number-of-alarms:5 | alarm-clock:config1 | power-on-select | dynamic-mute: off
all of which make a real difference to the user experience.

Bookmarks

Bookmarks are a usefull function that allows you to add favourites to a menu in the radio section. This can be added and deleted locally on the radio (unlike the My Stations feature that can only be added locally using the reply feature). I've only tested this with 257-a-756-a-030 on an AE, but will presumably work on all radios with this version of the firmware.

To turn bookmarks on:

Option:
bookmarks
on

To make it possible to add the current station to the bookmarks:

Option:
bookmark-on-long-select
on

or (depending on preference, although I have only tried the long select option)

Option:
bookmark-on-short-select
on

When you select a bookmark you will be given the option to play or delete from the list


Ipdio Style with firmware 257-a-756-a-183

Option:
dynamic-mute
off

Strongly recommended. Turns off the 3 sec delay and the cracking noise between tracks when playing mp3 from your upnp server. This was a big hassle for me, thanks to the sharpfin guys for solving this! When turning dynamic-mute off, you can no longer mute your radio with the mute button on the remote control!

Option:
reply-button-function
on

Strongly recommended. Add current station to MyStations at your reciva account.

Option:
long-browse-press-clears-media-queue
on

Sounds like a nice function to me.

Option:
report-empty-presets
on

Shows a message instead of doing nothing when pressing an empty preset key.

Option:
clock-format-menu
on

Option:
bitmap-clock
64x64 /usr/share/reciva/clockdata.bin

Enables cool looking analog clock, but did not show the correct time.

Option:
split-alarm-icons
on

Different Icons for different alarms.

How to turn off wireless on standby

NOTE: 20th March 2008

This Hack seems to be redundant as of FW v.257-a-615-a-075, which applies this powerdown feature as default (tested on IR100)


Note: September 10, 2008

This "feature" that now is also included with firmware v257-a-756-a-030 causes a new problem where the radio does not connect to the network after a power outage to get its time updated. This causes the clock to reset to midnight in Standby mode and is not a good idea for a radio used as an Alarm Clock. See this thread on reciva.com: https://www.reciva.com/index.php?option=com_joomlaboard&Itemid=108&func=view&catid=3&id=23869#23869



As noted on Bill888's support page, the Ipdio (962) uses less power on standby (2.9 watts vs. 7 watts), due to it's wireless being switched off.

A quick look through config962.txt threw up the following:

# --------------------------------------------
# Turn off wifi power in standby - start
# --------------------------------------------

Option:
soft-power-down
mode2

Option:
wireless-ethernet-connector
2

Option:
wireless-ethernet-pin
32

# --------------------------------------------
# Turn off wifi power in standby - end
# --------------------------------------------


I pasted this into config1012.txt, below the last 'Option' string and above the driver info and now my wireless is off when the radio is on standby, the dongle usb does not blink and I cannot ping from a command prompt or access the Sharpfin webserver.

Interestingly, the radio seems to switch on to connect and switch off much quicker now, which seems a bit contrary.

Presumably it is using less power as well, though I don't have a meter to test it with. It will be intersting to see if the radio uses less power switched on as per the ipdio as well.

This also has the benefit for those of us with external dongles of not leaving a hot, powered up dongle where little hands can find it when the radio is not in use.

ADVICE: IF YOU WANT TO COPY/PASTE THIS, COPY IT OVER FROM config962.txt TO config1012.txt FROM ONE VI WINDOW TO ANOTHER. COPYING IN WINDOWS TEXT FORMAT DOES NOT SEEM TO WORK.

AND MAKE SURE YOU CHECK IT!

Note: I've tested it with a lan-adapter[cable] and it's working great! (Radio:IR100) --Tim 20:33, 22 January 2008 (CET)

After changing "soft-power-down","wireless-ethernet-connector","wireless-ethernet-pin":
Power consumption(230V):
Working->Volume=min ->47,7mA
Working->Volume=max ->approx 60mA(depends on radio station/programm, tested with BBC1
Standby ->41,1mA
Unplugged the lan-adapter-> 41,1mA
--Tim 21:51, 22 January 2008 (CET)

An easier way to achieve this result:

include the line 'include config962.txt' in the config file of your radio. Config962 itself includes the line 'include config1012.txt' it would seem prudent to remove this, especially if you have an IR100 or similar.

NOTE: adding this line will also enable Stations History, Hierarchical Locations and Standby Text (Ipido Radio)

Podcasts in top menu

I just put this section in as a teporary measure to log attempts with this string, so we dont need to waste our time repeatedly trying the same values, it could doubtless do with a table if anyone knows how to knock one together.

podcasts-menu-position

'top' > tried with v257-a421-a-057 > no effect

'main' > tried with v257-a421-a-057 > no effect

Further notes and observations

This thread on the Reciva website has a few clues ( which may now all be explained above ).

*** For Tangent Quattro owners *** I tried some mods on the config931.txt. But after today's change I have bricked my radio.... I am running these software/firmware versions: v589-a-516-a-055;257-a-421-a-041;v24070821+00-a-012 One of these two mods causes the radio not to boot. Option: playback-layout clock-plus-1line [I had hoped to enable the clock when listening to radio or media server] Option: long-browse-press-clears-media-queue on So now I have to unbrick it! Just ordered the JTAG cable. When I have it and started to disassemble my Quattro MKII I will keep you posted. Bernard <nowiki>Insert non-formatted text here</nowiki>