obixDriver-OBixTuningPolicy

obixDriver-OBixTuningPolicy

This component provides a tuning policy for the oBIX network, with standard tuning policy properties.

Figure 17. Obix Network default tuning policy properties

Property	Value	Description
Min Write Time	hours minutes seconds	Specifies the minimum amount of time allowed between writes to writable proxy points, especially ones that have one or more linked inputs. This provides a way to throttle rapidly changing values so that only the last value is written. The default value (0) disables this rule causing all value changes to attempt to write.
Max Write Time	hours minutes seconds	Specifies the maximum amount of time to wait before rewriting the value, in case nothing else has triggered a write, to writable proxy points. Any write action resets this timer. The default (0) disables this rule resulting in no timed rewrites.
Write On Start	`true` (default) or `false`	Determines a writable proxy point’s behavior when the station starts. `true` initiates a write when the station first reaches a steady state. `false` prevents a write when the station first reaches a steady state. NOTE: Consider setting to `false` except for critical proxy points, otherwise large networks may experience write-queue-overflow exceptions.
Write On Up	`true` (default) or `false`	Determines a writable proxy point’s behavior when the point and its parent device transition from down to up. `true` initiates a write when a transition from down to up occurs. `false` prevents a write when a transition from down to up occurs.
Write On Enabled	`true` (default) or `false`	Determines a writable proxy point’s behavior when the point’s status transitions from disabled to normal (enabled). `true` initiates a write when the transition occurs. `false` prevents a write when the transition occurs.
Stale Time	hours minutes seconds	Defines the period of time without a successful read (indicated by a read status of {ok}) after which a point’s value is considered to be too old to be meaningful (stale). A non-zero value causes the point to become stale (status stale) if the configured time elapses without a successful read, indicated by Read Status {ok}. The default value (zero) disables the stale timer causing points to become stale immediately when unsubscribed.
Poll Frequency	drop-down list (defaults to `Normal`)	Selects among three rates (Fast, Normal and Slow) to determine how often to query the component for its value. The network’s Poll Service or Poll Scheduler defines these rates in hours, minutes and seconds. For example: `Fast` may set polling frequency to every second. `Normal` may set poll frequency to every five seconds. `Slow` may set poll frequency to every 30 seconds. This property applies to all proxy points.