Comb API Reference
In addition to logging data from a comb and exposing an HTTP API for
getting data, Brush also provides a Python API for communicating with
the Menlo XMLRPC server.
-
class
brush.comb.DummyFrequencyComb[source]
Simulated frequency comb for testing purposes.
-
get_data()[source]
Return random data in order to simulate the presence of a
Menlo XMLRPC server. Only a small subset of possible data keys
are provided.
| Returns: | randomized data values |
|---|
| Return type: | dict |
|---|
-
class
brush.comb.FrequencyComb(host, port=8123, user=None, password=None)[source]
Class for communicating with a Menlo frequency comb.
| Parameters: |
- host (str) – server hostname
- port (int) – server port
- user (str or None) – username for authentication
- password (str or None) – password for authentication
|
|---|
-
get_data()[source]
Query the XMLRPC server for the most recent data.
| Returns: | all data values |
|---|
| Return type: | dict |
|---|
-
get_version()[source]
Return the version of the Menlo XMLRPC server software.