Radiation Monitor Python Script Documentation - Revision history

Buckminst: /* reload_configuration */

2011-03-09T20:02:14Z

reload_configuration

2011-03-07T21:12:50Z

Connecting to the Radiation Monitor DBus service

2010-12-31T02:11:22Z

Protected "Radiation Monitor Python Script Documentation" ([edit=comp] (indefinite) [move=comp] (indefinite) [read=comp] (indefinite))

2010-09-15T21:09:46Z

Connecting to the Radiation Monitor DBus service

2010-09-15T21:09:28Z

Connecting to the Radiation Monitor DBus service

2010-09-15T21:09:00Z

Connecting to the Radiation Monitor DBus service

2010-09-15T21:07:57Z

DBus Quick Reference

2010-09-14T23:01:19Z

Configuration File

2010-09-14T22:58:29Z

sendto

2010-09-14T22:58:17Z

listen

@@ Line 180: / Line 180: @@
 This exposed DBus method will cause a running instance of the script to reload its configuration file, as if having been sent signal SIGHUP. It is invoked in the following manner:
   ''dbus_object''.'''reload_configuration()'''
-Then function always returns dbus.Boolean ''True'' at this time.
+The function always returns dbus.Boolean ''True'' at this time.
 Example output:
   >>> remote_object.reload_configuration()
   dbus.Boolean(True)

@@ Line 100: / Line 100: @@
 '''Note:''' The Radiation Monitor script must be run as ''root'' to connect to the System bus.
-Once you have successfully connected to the session bus, you will then want to get the DBus service object for the Radiation Monitor. This is done via the '''get_object''' bus method:
+Once you have successfully connected to the System bus, you will then want to get the DBus service object for the Radiation Monitor. This is done via the '''get_object''' bus method:
   ''dbus_object'' = ''dbus_bus''.'''get_object('''''service_name'', ''service_path''''')'''
 For our Radiation Monitor interface, the proper invocation is as follows:

@@ Line 97: / Line 97: @@
 ===Connecting to the Radiation Monitor DBus service===
 To interact with the Radiation Monitor DBus service in Python, you will first need to connect to the DBus System bus:
-  ''dbus_bus'' = '''dbus.System()'''
+  ''dbus_bus'' = '''dbus.SystemBus()'''
 '''Note:''' The Radiation Monitor script must be run as ''root'' to connect to the System bus.

@@ Line 98: / Line 98: @@
 To interact with the Radiation Monitor DBus service in Python, you will first need to connect to the DBus System bus:
   ''dbus_bus'' = '''dbus.System()'''
-The Radiation Monitor script must be run as ''root'' to connect to the System bus.
+'''Note:''' The Radiation Monitor script must be run as ''root'' to connect to the System bus.
 Once you have successfully connected to the session bus, you will then want to get the DBus service object for the Radiation Monitor. This is done via the '''get_object''' bus method:
   ''dbus_object'' = ''dbus_bus''.'''get_object('''''service_name'', ''service_path''''')'''

@@ Line 96: / Line 96: @@
   glib.init_threads()
 ===Connecting to the Radiation Monitor DBus service===
-To interact with the Radiation Monitor DBus service in Python, you will first need to connect to the DBus Session bus:
+To interact with the Radiation Monitor DBus service in Python, you will first need to connect to the DBus System bus:
-  ''dbus_bus'' = '''dbus.SessionBus()'''
+  ''dbus_bus'' = '''dbus.System()'''
 Once you have successfully connected to the session bus, you will then want to get the DBus service object for the Radiation Monitor. This is done via the '''get_object''' bus method:
   ''dbus_object'' = ''dbus_bus''.'''get_object('''''service_name'', ''service_path''''')'''
@@ Line 108: / Line 109: @@
   >>> remote_method()
   dbus.Int32(7)
 ===Introspection Schema===
 The Radiation Monitor DBus service returns the following schema upon being called with its inherited Introspect() method:

@@ Line 72: / Line 72: @@
 =API=
 ==DBus Quick Reference==
-'''Service Bus''': ''SessionBus()''
+'''Service Bus''': ''SystemBus()''
 '''Service Name''': ''iac.nagios.radmonitors''
@@ Line 85: / Line 85: @@
   '''add_send_client('''''string''''')'''
   '''reload_configuration()'''
 ==DBus Interaction==
 Before you can interact with the Radiation Monitor's DBus service, you will need to load some prerequisite Python libraries:

@@ Line 31: / Line 31: @@
   #nodaemon
   #truncate
 ===Configuration Directives===
 ====local====

@@ Line 43: / Line 43: @@
 ====sendto====
 This directive will allow you to specify any number of clients to forward the UDP packets on to, one per directive line. The proper syntax for this directive is as follows:
-  ''sendto'':''target_ip'':''target_port''
+  '''sendto''':''target_ip'':''target_port''
 Additional send clients can be added while the script is running by sending SIGHUP or using the DBus ''reload_configuration'' method to reload the configuration file, or by using the DBus ''add_send_client'' method.
 ====verbose====
 This directive sets the Radiation Monitor script into verbose interactive mode (non-daemonized), for the purposes of examining packet flow and diagnostics. This directive needs no arguments and can simply be specified in the configuration file.

@@ Line 38: / Line 38: @@
 ====listen====
 This directive will allow you to specify what interface/IP address and port to listen for packets on. By default this is set for UDP broadcasts on ''255.255.255.255''. The proper syntax for this directive is as follows:
-  '''listen'':''listen_ip'':''listen_port''
+  '''listen''':''listen_ip'':''listen_port''
 This directive cannot be changed during run-time.
 ====sendto====
 This directive will allow you to specify any number of clients to forward the UDP packets on to, one per directive line. The proper syntax for this directive is as follows: