README.getstate 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. NAME
  2. getstate.pm - Copyright (c)2008 Martin Fischer <m_fischer@gmx.de>
  3. SYNOPSIS
  4. getstate <devspec>
  5. DESCRIPTION
  6. The module getstate.pm extends FHEM to support a short status output of
  7. a device. It is useful for monitoring the device in e.g. Cacti.
  8. INSTALLATION
  9. Copy the script 99_getstate.pm to FHEM modules directory, e.g.
  10. 'cp 99_getstate.pm /usr/share/fhem/FHEM'
  11. and restart FHEM.
  12. EXAMPLES
  13. Output a short string of the "READINGS" for <devspec>.
  14. Example for a FS20-Device:
  15. fhem> getstate EG.sz.SD.Tv
  16. state:0
  17. Example for a FHT-Device:
  18. fhem> getstate EG.wz.HZ
  19. actuator:0 day-temp:21.5 desired-temp:21.5 lowtemp-offset:4.0 [...]
  20. Example for a KS300/555-Device:
  21. fhem> getstate GH.ga.WE.01
  22. humidity:93 israining:0 rain:207.8 rain_raw:815 temperature:5.1 [...]
  23. Example for a HMS-Device:
  24. fhem> getstate NN.xx.RM.01
  25. smoke_detect:0
  26. CONTRIB
  27. You can use the example script contrib/fhem-getstate as a "Data Input
  28. Method" for your Cacti graphs.
  29. LEGALESE
  30. License GPLv3+: GNU GPL version 3 or later
  31. <http://gnu.org/licenses/gpl.html>.
  32. This is free software: you are free to change and redistribute it. There
  33. is NO WARRANTY, to the extent permitted by law.
  34. AUTHOR
  35. Copyright (C) 2008 Martin Fischer <m_fischer@gmx.de>