The config module¶
The config module contains constants pertaining to configuration of pysiriproxy.
The Files class¶
- class pysiriproxy.options.config.Files[source]¶
The Files class contains definitions of various file paths that pertain to pysiriproxy configuration.
- CertFile¶
The CertFile property contains the path to the certification file for pysiriproxy.
- ConfigFile¶
The ConfigFile property contains the path to the configuration file for pysiriproxy.
- EtcHosts¶
The EtcHosts property contains the path to the system hosts file.
- GenCerts¶
The GenCerts property contains the path to the bash script that generates certificates for pysiriproxy.
- KeyFile¶
The KeyFile property contains the path to the key file to use for pysiriproxy.
- LogFile¶
The LogFile property contains the path to the log file to use for pysiriproxy.
The Vars class¶
- class pysiriproxy.options.config.Vars[source]¶
Define various variables that can be used within the configuration file.
Note
Variables should be all caps
- Config¶
The name of the variable which stores the path to the configuration file.
- Home¶
The name of the variable which stores the path to the user’s home directory.
The Directories class¶
- class pysiriproxy.options.config.Directories[source]¶
The Directories class contains various properties which define directories that contain pysiriproxy data.
- Config¶
The Config directory contains the user’s siri proxy configuration directory.
- Etc¶
The Etc property contains the path to the system etc directory.
- Home¶
The Home property contains the user’s home directory.
- Scripts¶
The Scripts property contains the scripts directory within the user’s siri proxy configuration directory.
- SiriInstall¶
The SiriInstall property contains the system installation directory for pysiriproxy.
- SystemDefaultConfig¶
The SystemDefaultConfig property contains the path to the system directory which contains the default configuration files created when pysiriproxy is installed on the system.
The Ids class¶
- class pysiriproxy.options.config.Ids[source]¶
The Ids class defines various configuration settings.
Note
ConfigParser converts all properties to lower case
- CertFile¶
The name of the configuration property that stores the certification file.
- DebugLevel¶
The name of the configuration property that stores the debug level for the system.
- ErrorResponse¶
The name of the configuration property that stores the string which Siri will respond with in the event that an Exception is encountered while processing an object filter, or a speech rule.
- ExitOnConnectionLost¶
The name of the configuration property that determines whether the server application will exit in the event that the connection to the iPhone is lost. This will allow an external script to restart the server cleanly each time the connection is lost.
- GenCerts¶
The name of the command line property that determines if the SSL certificates should be generated.
- Host¶
The name of the configuration property that stores a particular host name.
- IOsVersion¶
The name of the configuration property that stores the version of iOS that pysiriproxy should be configured for.
- KeyFile¶
The name of the configuration property that stores the path to the key file to use for the system.
- LogFile¶
The name of the configuration property that stores the path to the log file to use for the system.
- LogLevel¶
The name of the configuration property that stores the log level to use for the system.
- PluginsDir¶
The name of the configuration property that stores the path to the directory containing the plugin scripts.
- Port¶
The name of the configuration property that stores the port number to use.
- Timestamp¶
The name of the configuration property that stores the boolean indicating whether logged messages should be timestamped or not.
The Sections class¶
- class pysiriproxy.options.config.Sections[source]¶
The Sections class defines the names of the sections that can be used within the configuration file.
- Debug¶
The section containing debugging configuration settings.
- General¶
The section containing general configuration settings.
- Logging¶
The section containing settings pertaining to logging the system.
- Responses¶
The section containing settings pertaining to creating responses.
- Server¶
The section containing settings pertaining to Apple’s web server.
- iPhone¶
The section containing settings pertaining to the iPhone connection.
