hpigensimdata(1)

πŸ’– hpigensimdata(1) β€” the OpenHPI girlie's guide πŸ’–

okay so real talk, bestie, this whole page is about hpigensimdata, one of the OpenHPI client apps, and it's basically the dynamic simulator plugin's hype-woman. she reads your current config and spits out data for it. that's the whole vibe. let's get into it 🫢


✨ SYNOPSIS ✨

hpigensimdata [-D nn] [-N host[:port]] [-C <cfgfile>] [-r res_id] [-f filename] [-m UPD|INIT] [-h]
hpigensimdata [--domain=nn] [--host=host[:port]] [--cfgfile=file]
              [--resource=res_id] [--file=filename] [--mode=UPD|INIT] [--help]

like, two ways to say the same thing β€” short flags or long flags, pick your fighter πŸ’…


🌸 DESCRIPTION 🌸

hpigensimdata generates data for the dynamic simulator plugin by reading the current configuration. she will print all HPI information in a format that can be parsed by the Dynamic Simulator plugin. and because nobody wants to do extra work, to spare some encoding/decoding function, values of enums are printed as int values instead of encode them to ASCII values and decode them afterwards β€” no cap, that's literally what the page says, the ints stay ints 😌

since this client is primarily for the Dynamic Simulator, the output functions don't depend on the oh_.. - output function. which is honestly iconic of her, because that means they can be easily changed without influence on other clients. main character energy fr πŸ’…

please refer to README and detailed documentation with the plugin. she's not gonna explain everything twice, go read the docs bestie πŸ“–

if no domain or host is selected, ohparam uses the default domain as specified in the openhpiclient.conf file. (yes, the page really does say ohparam there β€” quoting it exactly, don't come for me πŸ™ˆ)

if no file name is specified, the data is displayed on console. so, you know, it just yells into your terminal instead πŸ—£οΈ


πŸŽ€ OPTIONS πŸŽ€

πŸ’œ Help Options:

  • -h, --help β€” show help options. the classic "wait what does this do again" button πŸ†˜

πŸ¦‹ Application Options:

  • -r res_id, --resource=res_id β€” select particular resource id for an update file. you're picking one specific resource to go in there 🎯
  • -f filename, --file=filename β€” name of the file to be generated. this is where the output goes, so name it something cute ✨
  • -m UPD|INIT, --mode=UPD|INIT β€” write update or initial file. those are the only two moods she has: UPD or INIT πŸ”₯
  • -D nn, --domain=nn β€” select domain id nn. just tell her which domain, nn is the number πŸ’«
  • -N "host[:port]", --host="host[:port]" β€” open session to the domain served by the daemon at the specified URL (host:port). this option overrides the OPENHPI_DAEMON_HOST and OPENHPI_DAEMON_PORT environment variables. if host contains ':' (for example IPv6 address) then enclose it in square brackets. for example: "[::1]" or "[::1]:4743". brackets, bestie, do not forget the brackets 😭
  • -C "file", --cfgfile="file" β€” use passed file as client configuration file. this option overrides the OPENHPICLIENT_CONF environment variable. she overrides the env var, she said so herself πŸ‘‘

🌈 SEE ALSO 🌈

the whole friend group, in her own words:

  • hpi_shell
  • hpialarms
  • hpifan
  • hpireset
  • hpitop
  • hpidomain
  • hpiinv
  • hpisensor
  • hpitree
  • hpiel
  • hpionIBMblade
  • hpisettime
  • hpiwdt
  • hpievents
  • hpipower
  • hpithres
  • hpixml
  • ohdomainlist
  • ohhandler
  • ohparam

πŸ‘‘ AUTHORS πŸ‘‘

authors of this man page, giving credit where credit is due 🫢

  • Ulrich Kleber (ulikleber@users.sourceforge.net)
  • Lars Wetzel (larswetzel@users.sourceforge.net)
  • Anton Pak (avpak@users.sourceforge.net)

lowkey a whole legend, highkey a whole legend β€” she's hpigensimdata from OpenHPI, version 4.0.0, dated 2023-01-26, and that's the vibe check, periodt πŸ’…βœ¨πŸŽ€πŸ¦‹