Skip to content

Available Config Options

Jump to bottom
gjr80 edited this page Aug 3, 2021 · 13 revisions

Config options

The operation of GW1000 driver is controlled by the use of config options in the [GW1000] stanza in weewx.conf. The GW1000 driver has been designed to operate with a number of sane defaults and hence only a minimal number of config options need be specified (when operated as a driver the only essential config option is the user option and there are no essential config options when operated as a WeeWX service). Most of the config options apply whether the GW1000 driver is operated as a driver or as a service, but some apply only when the GW1000 driver is operated as a driver or as a WeeWX service.

The available config options that may be used within the [GW1000] stanza in weewx.conf are outlined below.

When operated as a driver

The GW1000 driver supports the following config option in the [GW1000] stanza in weewx.conf when operated as a driver only:

driver. The location of the GW1000 driver file. Mandatory, string. Example usage:

driver = user.gw1000

Note: The GW1000 driver ignores the driver config option when run as a WeeWX service. Consequently, if it already exists, the driver option may be safely left in the [GW1000] stanza in weewx.conf when the GW1000 driver is run as a WeeWX service.

When operated as a driver or as a WeeWX service

The GW1000 driver supports the following configuration options in the [GW1000] stanza in weewx.conf when operated as a driver or as a WeeWX service:

ip_address. IP address of the GW1000. There is no default, if ip_address is not specified the GW1000 driver will attempt to locate GW1000 on the local network and use the first GW1000 found. Optional, string. Example usage:

ip_address = 192.168.0.100

port. Port number used when communicating with the GW1000. Optional, number. Default is 45000. Example usage:

port = 45000

poll_interval. Interval in seconds used to poll the GW1000 for data. Optional, number. Default is 60. Example usage:

poll_interval = 60

broadcast_address. The IP address to be used when sending a UDP broadcast to identify GW1000 devices on the network. Optional, string. Default is 255.255.255.255. Example usage:

broadcast_address = 255.255.255.255

broadcast_port. The port number to be used when sending a UDP broadcast to identify GW1000 devices on the network. Optional, number. Default is 46000. Example usage:

broadcast_port = 46000

socket_timeout. Timeout period in seconds used when sending a UDP broadcast or sending a command to the GW1000. Optional, number. Default is 2. Example usage:

socket_timeout = 2

max_tries. Number of times a command will be issued to the GW1000 before aborting if no valid response is received. Optional, number. Default is 3. Example usage:

max_tries = 3

retry_wait. Wait time in seconds between attempts to obtain a response from the GW1000. Optional, number. Default is 10. Example usage:

retry_wait = 10

field_map. The mapping of GW1000 fields to WeeWX fields. This setting overrides the default GW1000 driver field map. Optional. Example usage:

[[field_map]]
    outTemp = temp1
    outHumidity = humid1

would map GW1000 field temp1 (WH31 channel 1) to WeeWX field outTemp and GW1000 field humid1 (WH31 channel 1) to WeeWX field outHumidity. The field map will consist of these entries only and consequently the only GW1000 provided observations included in the emitted loop packet will be outTemp and outHumidity.

Note: As the [[field_map]] option overrides the entire default field map it may be easier to use the [[field_map_extensions]] option if there is a need to change only a few field map entries.

field_map_extensions. Changes to the default GW1000 driver field map. Rather than using the field_map option to override the entire default GW1000 driver field map, the field_map_extensions option can be used to alter one or more default field map entries. A default field map entry can be altered by simply redefining it. Optional. Example usage:

[[field_map_extensions]]
    outTemp = temp8

would override the default mapping of GW1000 field temp8 (WH31 channel 8) to WeeWX field extraTemp8 and instead map GW1000 field temp8 to WeeWX field outTemp. The previous default mapping of GW1000 field temp8 to WeeWX field extraTemp8 will be removed from the field map but all other field map entries will remain as is.

debug_rain. Includes additional rain related information in the log to assist in the debugging of rain related issues. This config option is independent of the WeeWX debug config option and is useful for obtaining just GW1000 rain related debug output. Optional, boolean. Example usage:

debug_rain = True

When operated as a service

The GW1000 driver supports the following config option in the [GW1000] stanza in weewx.conf when operated as a WeeWX service only:

max_age. Maximum age of GW1000 data in seconds before the data is considered stale and discarded. Optional, number. Default is 60. Example usage:

max_age = 60

Note: The GW1000 driver ignores the max_age config option when run as a driver. Consequently, if it already exists, the max_age option may be safely left in the [GW1000] stanza in weewx.conf when the GW1000 driver is run as a driver.

Clone this wiki locally