HorlogeSkynet/SimpleConkyScript
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Compare commits

...

2 Commits
1a15400594 ... e06603a277

Author SHA1 Message Date
Samuel FORESTIER
e06603a277 Fixes some typos and globally improves configuration documentation 2019-08-25 22:29:32 +02:00
Samuel FORESTIER
7b6e04998b Allows careless persons to specify a lowercased temperature unit 2019-08-25 22:28:27 +02:00
2 changed files with 15 additions and 15 deletions

28
README.md

@ -183,11 +183,11 @@ To achieve this, you can either use pre-defined types of entity (detailed below)
//
// `interval` represents the number of iterations to wait before executing the command again (the output is cached).
// Please be careful, with `update_interval` Conky setting set to 2 seconds, such a command would be executed each 3600 * 2 seconds, or 2 hours.
// You MAY set `interval` to `null` to completely disable value update (the first obtained output would be kept until reloading).
// You MAY set `interval` to `null` to completely disable value update (the first obtained output would be kept until reload).
// Inversely, you MAY set `interval` to `0` (or even omit the entry) to update it during each iteration (use at your own risks).
//
// `pre_text` and `post_text` (fully-optional values) allow you to respectively set some texts before and after obtained output.
// `align_center` acts described above for `text` entities.
// `align_center` acts as described above for `text` entities.
//
// When the command fails, `on_error` content will be displayed.
"type": "command",
@ -208,7 +208,8 @@ To achieve this, you can either use pre-defined types of entity (detailed below)
//
// `show_percent` is also available and MAY be tweaked.
//
// Please be careful, set file paths below MAY NOT work on your system.
// Please be careful, distributed file paths MAY NOT work on your system.
// You MAY run `ls -l /sys/class/backlight/` to check what is actually available on your system.
"type": "brightness",
"name": "Brightness",
"cur_file": "/sys/class/backlight/intel_backlight/actual_brightness",
@ -232,14 +233,14 @@ To achieve this, you can either use pre-defined types of entity (detailed below)
// This entity relies entirely on the LM-SENSORS program.
// It underly uses a `sensors` call to retrieve temperature information from a chip.
// The identifier of the `chip` to prompt MUST be specified and could be found by manually running `sensors -A`.
// The final displayed value correspond to the chip temperature inputs average.
// The final displayed value corresponds to the chip temperature inputs average.
//
// `interval` acts as described for `command` type entity (see above).
//
// `threshold` represents the maximum temperature value that could be reached before adding the symbol specified in `settings.temperature.warning` (see above).
// You can either specify Celsius or Fahrenheit, as long as it is consistent to the unit specified in `settings.temperature.unit` (see above too).
// You can either specify a Celsius or Fahrenheit value, as long as it is consistent to the unit specified in `settings.temperature.unit` (see above too).
//
// When no temperature could be computed, `on_error` will be displayed.
// When no temperature could be retrieved or computed, `on_error` will be displayed.
"type": "sensor_temperature",
"name": "CPUs",
"chip": "coretemp-isa-0000",
@ -249,9 +250,9 @@ To achieve this, you can either use pre-defined types of entity (detailed below)
},
{
// This entity works as the `sensor_temperature` above, but relies on the HDDTEMP program.
// You'll have to specify the path to the targeted drive.
// You'll have to specify the path to the targeted `drive`.
//
// `wake_up` allows you to force drive wake up if needed to measure its temperature (disabled by default).
// `wake_up` allows you to force drive wake up (when needed) to measure its temperature (disabled by default).
//
// `interval`, `threshold` and `on_error` acts as described for `sensor_temperature` type entity (see above).
"type": "drive_temperature",
@ -264,7 +265,7 @@ To achieve this, you can either use pre-defined types of entity (detailed below)
{
// This entity is a handy wrapper to the 'bar' entity.
// By specifying any partition `mount_point`, it will display a 'bar' representing its usage.
// `show_percent` acts as described above for `bar` entities (see above).
// `show_percent` acts as described above for `bar` entities.
"type": "partition_usage",
"mount_point": "/home/",
"show_percent": false
@ -294,11 +295,10 @@ To achieve this, you can either use pre-defined types of entity (detailed below)
},
{
// This entity is a disguised 'text' object.
// It allows you to show Conky version, with `{pre,post}_text` (active as within the `command` entity).
//
// `align_center` is available and acting as described above.
//
// It allows you to show Conky version, with `{pre,post}_text` (acting as with the `command` entity).
// It could be very useful to give you credits on screen-shot for instance.
//
// `align_center` is available and acts as described above.
"type": "version",
"pre_text": "Horloge's script on ",
"post_text": "",
@ -320,7 +320,7 @@ To achieve this, you can either use pre-defined types of entity (detailed below)
### My Conky does not work, it \[insert your very specific issue details here\]. What should I do ?
Please, refer to the [official Conky's FAQ](https://github.com/brndnmtthws/conky/wiki/FAQ) first.
If you can't find anything helpful, please [contact me](mailto:dev+conky@samuel.domains) with your Conky terminal output attached.
If you can't find anything helpful, please [contact me](mailto:dev+conky@samuel.domains) with your configuration and Conky terminal output attached.
### Your script is cool but I'd like to install it elsewhere. How could I achieve that ?

2
lua/system.lua

@ -80,7 +80,7 @@ function system.compute_avg_chip_temp(chip_name)
end
-- When the Fahrenheit unit is specified, let's perform a manual conversion.
if _settings.temperature.unit == 'F' then
if string.upper(_settings.temperature.unit) == 'F' then
avg_temp = (avg_temp * (9 / 5.)) + 32
end