Template:NetworkServerConfig: Difference between revisions

From Phidgets Support
(Created page with "==Configuring the Phidget Network Server== There are two different ways to configure the Phidget Network Server: *via the Phidget Control Panel (for Windows and macOS users)....")
 
No edit summary
Line 90: Line 90:
*'''maxfiles:''' the maximum number of log files to keep before rotation deletes them.
*'''maxfiles:''' the maximum number of log files to keep before rotation deletes them.
*'''maxsize:''' the maximum file size of a log file before rotation.
*'''maxsize:''' the maximum file size of a log file before rotation.
*'''network->enabled:''' enable network logging.
 
*'''network->port:''' '''UNKNOWN'''
''network''
*'''enabled:''' enable network logging.
*'''port:''' '''NEED MORE INFO'''
|}
 
 
{|
|style="width:55%"|<syntaxhighlight>
phidget{
    network {
        keepalive: 30000
ipv4 {
    address: localhost
    port: 5661
}
datagram {
    enabled: true
}
publish {
    enabled: true
    name: 'Phidget22 Server'
}
resolveaddrs: false
    }
}
</syntaxhighlight>
|
''network''
*'''keepalive:''' '''NEED MORE INFO'''
*'''resolveaddrs:''' if addresses should be resolved to names (affects performance)
 
''ipv4''
*'''address:''' the address to bind. '''can we give more info here?'''
*'''port:''' server port. '''other options for this setting?'''
 
''datagram''
*enabled: if UDP for events is allowed. '''can we give more info here?'''
 
''publish''
*'''enabled:''' when ''true'', your Phidget Network Server will be published to mDNS.
*'''name:''' the name of your Phidget Network Server that will be published (defaults to computer name).
|}
|}

Revision as of 20:31, 30 June 2017

Configuring the Phidget Network Server

There are two different ways to configure the Phidget Network Server:

  • via the Phidget Control Panel (for Windows and macOS users). This provides a simple way for you to make changes to the Phidget Network Server, however, not all settings are available.
  • modifying the Phidget Network Server configuration file directly. All settings are available, but it is not as user-friendly.


Find the configuration file on your machine by referencing the following table:

Operating System Location
Linux /etc/phidgets/
Windows C:/ProgramData/Phidgets
macOS /Library/Preferences/Phidget22NetworkServer/

Now that you have the configuration file on hand, we will go through each setting and describe it.

Settings

phidget{
   enabled: true
}
 Enable the Phidget Server and provide access to Phidget channels over the network. This does not disable the WWW server, and web clients may still access Phidget channels. 


phidget{
    auth {
        password: 'temp123'
    }
}
 Set a password for your Phidget Server. 


phidget{
    pidfile: '/var/run/phidget22networkserver.pid'
}
 For UNIX machines only. NEED MORE INFO 


    logging {
        level: info
	file: 'c:/tmp/networkserver.log'
	maxfiles: 4
        maxsize: 1048576
	network {
	    enabled: true
	    port: 5771
	}
	source {
	    phidget22net {
	        level: info
	    }
	    _phidget22usb {
	        level: info
	    }
	    _phidget22match {
	        level: error
	    }
	    _phidget22channel {
	        level: error
	    }
	    _phidget22bridge {
		level: error
	    }
	    _phidget22disp {
		level: error
	    }
        }
    }
  • The use of level throughout this code block refers to log level. See the Phidget Control Panel logging section for more information.
  • file: choose the log file location and name.
  • maxfiles: the maximum number of log files to keep before rotation deletes them.
  • maxsize: the maximum file size of a log file before rotation.

network

  • enabled: enable network logging.
  • port: NEED MORE INFO


phidget{
    network {
        keepalive: 30000
	ipv4 {
	    address: localhost
	    port: 5661
	}
	datagram {
	    enabled: true
	}
	publish {
	    enabled: true
	    name: 'Phidget22 Server'
	}
	resolveaddrs: false
    }
}

network

  • keepalive: NEED MORE INFO
  • resolveaddrs: if addresses should be resolved to names (affects performance)

ipv4

  • address: the address to bind. can we give more info here?
  • port: server port. other options for this setting?

datagram

  • enabled: if UDP for events is allowed. can we give more info here?

publish

  • enabled: when true, your Phidget Network Server will be published to mDNS.
  • name: the name of your Phidget Network Server that will be published (defaults to computer name).
Retrieved from "https://www.phidgets.com/docs/index.php?title=Template:NetworkServerConfig&oldid=28135"