mod_csi_battery_saver/README.markdown
author tmolitor <thilo@eightysoft.de>
Tue, 22 Aug 2017 20:10:10 +0200
changeset 2752 ff0495909d4e
parent 2750 d3a2f4bdaf09
child 2758 d1aa5fc005f7
permissions -rw-r--r--
mod_csi_battery_saver: Fix small bug and correct readme. See https://github.com/ChatSecure/ChatSecure-iOS/issues/770#issuecomment-323534057 for a description of the bug.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2610
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
     1
---
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
     2
description: CSI module to save battery on mobile devices
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
     3
labels:
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
     4
- 'Stage-Alpha'
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
     5
---
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
     6
2745
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation
tmolitor <thilo@eightysoft.de>
parents: 2610
diff changeset
     7
Please use this module instead of [mod_csi_pump] if you want timestamping,
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation
tmolitor <thilo@eightysoft.de>
parents: 2610
diff changeset
     8
properly handled carbon copies, support for handling encrypted messages and
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation
tmolitor <thilo@eightysoft.de>
parents: 2610
diff changeset
     9
correctly handled smacks events.
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation
tmolitor <thilo@eightysoft.de>
parents: 2610
diff changeset
    10
2749
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating
tmolitor <thilo@eightysoft.de>
parents: 2745
diff changeset
    11
If smacks is used on the same server this needs at least version [f70c02c14161]
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating
tmolitor <thilo@eightysoft.de>
parents: 2745
diff changeset
    12
of the smacks module! There could be message reordering on resume otherwise.
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating
tmolitor <thilo@eightysoft.de>
parents: 2745
diff changeset
    13
2610
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    14
Stanzas are queued in a buffer until either an "important" stanza is
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    15
encountered or the buffer becomes full. Then all queued stanzas are sent
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    16
at the same time. This way, nothing is lost or reordered while still
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    17
allowing for power usage savings by not requiring mobile clients to
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    18
bring up their radio for unimportant stanzas.
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    19
2745
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation
tmolitor <thilo@eightysoft.de>
parents: 2610
diff changeset
    20
`IQ` stanzas, and `message` stanzas containing a body or being encypted
2752
ff0495909d4e mod_csi_battery_saver: Fix small bug and correct readme.
tmolitor <thilo@eightysoft.de>
parents: 2750
diff changeset
    21
and all nonzas are considered important.
ff0495909d4e mod_csi_battery_saver: Fix small bug and correct readme.
tmolitor <thilo@eightysoft.de>
parents: 2750
diff changeset
    22
If the config option `csi_battery_saver_filter_muc` is set to true,
ff0495909d4e mod_csi_battery_saver: Fix small bug and correct readme.
tmolitor <thilo@eightysoft.de>
parents: 2750
diff changeset
    23
groupchat messages must set a subject or have the user's username or nickname
ff0495909d4e mod_csi_battery_saver: Fix small bug and correct readme.
tmolitor <thilo@eightysoft.de>
parents: 2750
diff changeset
    24
in their messages to count as "important", if the config is false (default), all
ff0495909d4e mod_csi_battery_saver: Fix small bug and correct readme.
tmolitor <thilo@eightysoft.de>
parents: 2750
diff changeset
    25
groupchat messages havin a body or being encrypted are considered "important".
ff0495909d4e mod_csi_battery_saver: Fix small bug and correct readme.
tmolitor <thilo@eightysoft.de>
parents: 2750
diff changeset
    26
`Presence` stanzas are always considered not "important".
2610
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    27
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    28
All buffered stanzas that allow timestamping are properly stamped to
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    29
reflect their original send time, see [XEP-0203].
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    30
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    31
Use with other CSI plugins such as [mod_throttle_presence],
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    32
[mod_filter_chatstates] or [mod_csi_pump] is *not* supported.
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    33
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump
tmolitor <thilo@eightysoft.de>
parents:
diff changeset
    34
The internal stanza buffer of this module is hardcoded to 100 stanzas.
2749
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating
tmolitor <thilo@eightysoft.de>
parents: 2745
diff changeset
    35
2750
d3a2f4bdaf09 mod_csi_battery_saver: Add config option for better muc handling
tmolitor <thilo@eightysoft.de>
parents: 2749
diff changeset
    36
Configuration
d3a2f4bdaf09 mod_csi_battery_saver: Add config option for better muc handling
tmolitor <thilo@eightysoft.de>
parents: 2749
diff changeset
    37
=============
d3a2f4bdaf09 mod_csi_battery_saver: Add config option for better muc handling
tmolitor <thilo@eightysoft.de>
parents: 2749
diff changeset
    38
d3a2f4bdaf09 mod_csi_battery_saver: Add config option for better muc handling
tmolitor <thilo@eightysoft.de>
parents: 2749
diff changeset
    39
  Option                              Default           Description
d3a2f4bdaf09 mod_csi_battery_saver: Add config option for better muc handling
tmolitor <thilo@eightysoft.de>
parents: 2749
diff changeset
    40
  ----------------------------------  ---------- -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
d3a2f4bdaf09 mod_csi_battery_saver: Add config option for better muc handling
tmolitor <thilo@eightysoft.de>
parents: 2749
diff changeset
    41
  `csi_battery_saver_filter_muc`      false      Controls whether all muc messages having a body should be considered as important (false) or only such containing the user's room nic (true). Warning: you should only set this to true if your users can live with muc messages being delayed several minutes. 
d3a2f4bdaf09 mod_csi_battery_saver: Add config option for better muc handling
tmolitor <thilo@eightysoft.de>
parents: 2749
diff changeset
    42
d3a2f4bdaf09 mod_csi_battery_saver: Add config option for better muc handling
tmolitor <thilo@eightysoft.de>
parents: 2749
diff changeset
    43
2749
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating
tmolitor <thilo@eightysoft.de>
parents: 2745
diff changeset
    44
[f70c02c14161]: //hg.prosody.im/prosody-modules/raw-file/f70c02c14161/mod_smacks/mod_smacks.lua