Module device.kobo.nickel_conf

Access and modify values in Kobo eReader.conf used by Nickel.

Only PowerOptions:FrontLightLevel is currently supported.

Functions

NickelConf.frontLightLevel.get () Get frontlight level.
NickelConf.frontLightState.get () Get frontlight state.
NickelConf.colorSetting.get () Get color setting.
NickelConf.autoColorEnabled.get () Get auto color enabled.
NickelConf._write_kobo_conf (re_Match, key, value, dontcreate) Write Kobo configuration.
NickelConf.frontLightLevel.set (new_intensity) Set frontlight level.
NickelConf.frontLightState.set (new_state) Set frontlight state.
NickelConf.colorSetting.set (new_color) Set color setting.
NickelConf.autoColorEnabled.set (new_autocolor) Set auto color enabled.


Functions

NickelConf.frontLightLevel.get ()
Get frontlight level.

Returns:

    int Frontlight level.
NickelConf.frontLightState.get ()
Get frontlight state.

This entry will be missing for devices that do not have a hardware toggle button. We return nil in this case.

Returns:

    int Frontlight state (or nil).
NickelConf.colorSetting.get ()
Get color setting.

Returns:

    int Color setting.
NickelConf.autoColorEnabled.get ()
Get auto color enabled.

Returns:

    bool Auto color enabled.
NickelConf._write_kobo_conf (re_Match, key, value, dontcreate)
Write Kobo configuration.

Parameters:

  • re_Match string Lua pattern.
  • key string Kobo conf key.
  • value
  • dontcreate bool Don't create if key doesn't exist.
NickelConf.frontLightLevel.set (new_intensity)
Set frontlight level.

Parameters:

  • new_intensity int
NickelConf.frontLightState.set (new_state)
Set frontlight state.

Parameters:

  • new_state bool
NickelConf.colorSetting.set (new_color)
Set color setting.

Parameters:

  • new_color int >= 1500 and <= 6400
NickelConf.autoColorEnabled.set (new_autocolor)
Set auto color enabled.

Parameters:

  • new_autocolor bool
generated by LDoc 1.4.6 Last updated 2019-09-14 22:30:13