Radiation Monitor Python Script Documentation - Revision history

Buckminst: /* reload_configuration */

2011-03-09T20:02:14Z

reload_configuration

← Older revision		Revision as of 20:02, 9 March 2011
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:		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()'''		''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:		Example output:
	>>> remote_object.reload_configuration()		>>> remote_object.reload_configuration()
	dbus.Boolean(True)		dbus.Boolean(True)

Buckminst: /* Connecting to the Radiation Monitor DBus service */

2011-03-07T21:12:50Z

Connecting to the Radiation Monitor DBus service

← Older revision		Revision as of 21:12, 7 March 2011
Line 100:		Line 100:
	'''Note:''' 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:		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''''')'''		''dbus_object'' = ''dbus_bus''.'''get_object('''''service_name'', ''service_path''''')'''
	For our Radiation Monitor interface, the proper invocation is as follows:		For our Radiation Monitor interface, the proper invocation is as follows:

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

2010-12-31T02:11:22Z

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

← Older revision	Revision as of 02:11, 31 December 2010
(No difference)

Buckminst: /* Connecting to the Radiation Monitor DBus service */

2010-09-15T21:09:46Z

Connecting to the Radiation Monitor DBus service

← Older revision		Revision as of 21:09, 15 September 2010
Line 97:		Line 97:
	===Connecting to the Radiation Monitor DBus service===		===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:		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.		'''Note:''' The Radiation Monitor script must be run as ''root'' to connect to the System bus.

Buckminst: /* Connecting to the Radiation Monitor DBus service */

2010-09-15T21:09:28Z

Connecting to the Radiation Monitor DBus service

← Older revision		Revision as of 21:09, 15 September 2010
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:		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.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:		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''''')'''		''dbus_object'' = ''dbus_bus''.'''get_object('''''service_name'', ''service_path''''')'''

Buckminst: /* Connecting to the Radiation Monitor DBus service */

2010-09-15T21:09:00Z

Connecting to the Radiation Monitor DBus service

← Older revision		Revision as of 21:09, 15 September 2010
Line 96:		Line 96:
	glib.init_threads()		glib.init_threads()
	===Connecting to the Radiation Monitor DBus service===		===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()'''
			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 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''''')'''		''dbus_object'' = ''dbus_bus''.'''get_object('''''service_name'', ''service_path''''')'''
Line 108:		Line 109:
	>>> remote_method()		>>> remote_method()
	dbus.Int32(7)		dbus.Int32(7)

	===Introspection Schema===		===Introspection Schema===
	The Radiation Monitor DBus service returns the following schema upon being called with its inherited Introspect() method:		The Radiation Monitor DBus service returns the following schema upon being called with its inherited Introspect() method:

Buckminst: /* DBus Quick Reference */

2010-09-15T21:07:57Z

DBus Quick Reference

← Older revision		Revision as of 21:07, 15 September 2010
Line 72:		Line 72:
	=API=		=API=
	==DBus Quick Reference==		==DBus Quick Reference==
	'''Service Bus''': ''~~SessionBus~~()''		'''Service Bus''': ''SystemBus()''

	'''Service Name''': ''iac.nagios.radmonitors''		'''Service Name''': ''iac.nagios.radmonitors''
Line 85:		Line 85:
	'''add_send_client('''''string''''')'''		'''add_send_client('''''string''''')'''
	'''reload_configuration()'''		'''reload_configuration()'''

	==DBus Interaction==		==DBus Interaction==
	Before you can interact with the Radiation Monitor's DBus service, you will need to load some prerequisite Python libraries:		Before you can interact with the Radiation Monitor's DBus service, you will need to load some prerequisite Python libraries:

Buckminst: /* Configuration File */

2010-09-14T23:01:19Z

Configuration File

← Older revision		Revision as of 23:01, 14 September 2010
Line 31:		Line 31:
	#nodaemon		#nodaemon
	#truncate		#truncate

			Lines beginning with # are ignored by the script and may be used for comments on lines seperate from directive lines, or to remove directives from active use. For comments on lines containing directives, please place them at the end and prepend a : before the comment.
	===Configuration Directives===		===Configuration Directives===
	====local====		====local====

Buckminst: /* sendto */

2010-09-14T22:58:29Z

sendto

← Older revision		Revision as of 22:58, 14 September 2010
Line 43:		Line 43:
	====sendto====		====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:		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.		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====		====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.		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.

Buckminst: /* listen */

2010-09-14T22:58:17Z

listen

← Older revision		Revision as of 22:58, 14 September 2010
Line 38:		Line 38:
	====listen====		====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:		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.		This directive cannot be changed during run-time.

	====sendto====		====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:		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: