Remote-interface communication - Revision history

Sebastian Kuhlen: /* /get */

2024-09-14T17:09:31Z

/get

Sebastian Kuhlen at 05:58, 6 December 2022

2022-12-06T05:58:24Z

Sebastian Kuhlen at 20:31, 16 December 2020

2020-12-16T20:31:55Z

Sebastian Kuhlen at 21:19, 20 May 2020

2020-05-20T21:19:23Z

Sebastian Kuhlen: /* Documents */

2020-05-20T21:18:50Z

Documents

Sebastian Kuhlen at 13:53, 20 December 2019

2019-12-20T13:53:25Z

Sebastian Kuhlen at 21:41, 17 February 2019

2019-02-17T21:41:00Z

Sebastian Kuhlen: /* /export */

2018-10-17T18:38:41Z

/export

Sebastian Kuhlen at 20:30, 20 June 2018

2018-06-20T20:30:15Z

Sebastian Kuhlen at 18:48, 11 September 2016

2016-09-11T18:48:56Z

@@ Line 26: / Line 26: @@
 Retrieving the full buffer is straight forward, but can be quite inefficient. Instead using the threshold can save a lot of bandwidth if you only need to retrieve new data from a monotonic reference. A typical example is a time axis - you have already received data from a sensor every second as pairs of (time|value): (1,7), (2,-1), (3,4) As you know, that "time" will always increase monotonic. So from buffer "time", you only need to request anything after the value 3: "/get?t=3". Buffer "value" is slightly more complicated as it might have any value, but you know that you only need those values at the same index as the values of "time" larger than 3. So, when giving a threshold to a buffer in the get-request, you can add a specific reference buffer: "/get?time=3&value=3|time". If the threshold value does not belong to the requested buffer itself, you have to provide it after the threshold with the symbol "|".
 This is necessary as values are not explicitly paired in phyphox experiment. It may be absolutely valid, that you need a subset from the "time" buffer, and the full "value" buffer, which might be unrelated. So, a last example:
@@ Line 53: / Line 55: @@
 "session" gives a string identifier which is unique per session. If this changes, you may expect that the user has switched to a different experiment and all your old data has become invalid. "measuring" gives the current state of the measurement - false means that the experiment is paused, true that it is running. "timedRun" and "countDown" represent the timed run function. In this case it is enabled and will stop the current measurement in 2.7 seconds. If "measuring" was false, it would mean that the measurement would start in 2.7 seconds.
 === /control ===

← Older revision		Revision as of 05:58, 6 December 2022
Line 4:		Line 4:

	Here is a little example on how to use this interface to control musical instruments: https://www.youtube.com/watch?v=sFx9zZKe4E4		Here is a little example on how to use this interface to control musical instruments: https://www.youtube.com/watch?v=sFx9zZKe4E4
		+
		+	The [https://phyphox.org/phyphox-files/phyphox2midi.py Python script] from this video is a quick solution specific for the MIDI interface of musical experiments, but it may be useful as a starting point for other projects.

	As the interface is designed around a webserver running on the phone, all functions are available as documents below the devices URL. So, this documentation will list all these documents from the document root. For example "/get" can be called as http://192.168.0.42:8080/get (if the phone's IP is 192.168.0.42 and the server is running on port 8080. On iPhones, the server runs in port 80, so for http the port can usually be omitted.)		As the interface is designed around a webserver running on the phone, all functions are available as documents below the devices URL. So, this documentation will list all these documents from the document root. For example "/get" can be called as http://192.168.0.42:8080/get (if the phone's IP is 192.168.0.42 and the server is running on port 8080. On iPhones, the server runs in port 80, so for http the port can usually be omitted.)

← Older revision		Revision as of 20:31, 16 December 2020
Line 91:		Line 91:
	;export		;export
	: An array of export sets, which in turn contain combinations of labels and buffers. These are the buffers that have been chosen by the configuration author which should be included if the user exports the data. In properly designed experiments, these contain valid data.		: An array of export sets, which in turn contain combinations of labels and buffers. These are the buffers that have been chosen by the configuration author which should be included if the user exports the data. In properly designed experiments, these contain valid data.
		+
		+	=== /meta ===
		+	'''Available since [[Version_history#1.1.8\|version 1.1.8]]'''
		+
		+	"meta" does not take any parameters and returns a JSON structure with information about the device and its software. This is all the metadata listed on the [[https://phyphox.org/wiki/index.php/Network_Connections#Metadata\|network connections documentation]] except for the unique id.
		+
		+	=== /time ===
		+	'''Available since [[Version_history#1.1.8\|version 1.1.8]]'''
		+
		+	"time" does not take any parameters and returns a JSON structure with information helping to synchronize the data from this device to the real world using its system clock. The result is a simle JSON array with event objects representing events during experimentation, which at the moment are start and pause, when the user started or paused the experiment. Each event entry has the experiment time (seconds since first start of the experiment, ignoring pauses) and the system time (seconds since 1970) of the event, which allows to map the timestamp of sensor data (experiment time) to the real world.
		+
		+	Note, that the experiment time is based on the devices high resolution clock, which runs independently of the system clock. On each event phyphox reads both clocks right after each other to get a match that should be accurate to within few milliseconds. However, as both clocks run independently, they may diverge over time and especially if the system clock is updated, which is usually done automatically in the background by the operating system.

← Older revision		Revision as of 21:19, 20 May 2020
Line 91:		Line 91:
	;export		;export
	: An array of export sets, which in turn contain combinations of labels and buffers. These are the buffers that have been chosen by the configuration author which should be included if the user exports the data. In properly designed experiments, these contain valid data.		: An array of export sets, which in turn contain combinations of labels and buffers. These are the buffers that have been chosen by the configuration author which should be included if the user exports the data. In properly designed experiments, these contain valid data.
−
−	~~==Problems and future changes==~~
−
−	A design flaw for external use is that the experiment setup with the used buffer names and the list of available export formats is currently written into the HTML file provided with the root document. This way, it is hard to parse this information. In a future version this will probably be made available through a JSON interface. If you need this functionality, please send us an email, so we know that it should move up in our priority list.

@@ Line 69: / Line 69: @@
 === /export ===
 When requesting "export", you are effectively triggering the export function of phyphox to retrieve all recorded data in a single file. You can specify the format of this file using the index of the available formats. For example /export?format=0 will give an Excel file and /export?format=2 will give a CSV file (at the time of this writing).
 ==Problems and future changes==
 A design flaw for external use is that the experiment setup with the used buffer names and the list of available export formats is currently written into the HTML file provided with the root document. This way, it is hard to parse this information. In a future version this will probably be made available through a JSON interface. If you need this functionality, please send us an email, so we know that it should move up in our priority list.

← Older revision		Revision as of 13:53, 20 December 2019
Line 1:		Line 1:
−	While the [http://phyphox.org/remote-control/ remote interface] of phyphox is a very powerful tool, you might be interested in communicating and controlling phyphox directly using your own software. The web page called by your browser when using the default remote interface is mostly based on some (not too complex) Javascript code. This code does a range of AJAX requests and receives responses in a JSON format, which are documented on this page.	+	While the [http://phyphox.org/remote-control/ remote interface] of phyphox is a very powerful tool, you might be interested in communicating and controlling phyphox directly using your own software. The web page called by your browser when using the default remote interface is mostly based on some (not too complex) Javascript code. This code does a range of AJAX requests and receives responses in a JSON format, which are documented on this page. So, when the remote access feature is enabled, phyphox can be controlled through a REST API.

	In principle, with this information, you could embed phyphox into many other projects. For example, you could write an interface to perform measurements including more than one phones with phyphox or you could include phyphox into a more capable measurement software (LabView, Labber, Matlab) or control phyphox alongside other lab equipment like programmable voltage sources or power supplies of electro magnets.		In principle, with this information, you could embed phyphox into many other projects. For example, you could write an interface to perform measurements including more than one phones with phyphox or you could include phyphox into a more capable measurement software (LabView, Labber, Matlab) or control phyphox alongside other lab equipment like programmable voltage sources or power supplies of electro magnets.

← Older revision		Revision as of 21:41, 17 February 2019
Line 6:		Line 6:

	As the interface is designed around a webserver running on the phone, all functions are available as documents below the devices URL. So, this documentation will list all these documents from the document root. For example "/get" can be called as http://192.168.0.42:8080/get (if the phone's IP is 192.168.0.42 and the server is running on port 8080. On iPhones, the server runs in port 80, so for http the port can usually be omitted.)		As the interface is designed around a webserver running on the phone, all functions are available as documents below the devices URL. So, this documentation will list all these documents from the document root. For example "/get" can be called as http://192.168.0.42:8080/get (if the phone's IP is 192.168.0.42 and the server is running on port 8080. On iPhones, the server runs in port 80, so for http the port can usually be omitted.)
		+
		+	Also, if you are developing a Java application, you might want to check out this [https://github.com/tfassbender/phyphox_java_interface Java interface] created by Tobias Faßbender, FH Aachen.

	==Documents==		==Documents==

← Older revision		Revision as of 20:30, 20 June 2018
Line 2:		Line 2:

	In principle, with this information, you could embed phyphox into many other projects. For example, you could write an interface to perform measurements including more than one phones with phyphox or you could include phyphox into a more capable measurement software (LabView, Labber, Matlab) or control phyphox alongside other lab equipment like programmable voltage sources or power supplies of electro magnets.		In principle, with this information, you could embed phyphox into many other projects. For example, you could write an interface to perform measurements including more than one phones with phyphox or you could include phyphox into a more capable measurement software (LabView, Labber, Matlab) or control phyphox alongside other lab equipment like programmable voltage sources or power supplies of electro magnets.
		+
		+	Here is a little example on how to use this interface to control musical instruments: https://www.youtube.com/watch?v=sFx9zZKe4E4

	As the interface is designed around a webserver running on the phone, all functions are available as documents below the devices URL. So, this documentation will list all these documents from the document root. For example "/get" can be called as http://192.168.0.42:8080/get (if the phone's IP is 192.168.0.42 and the server is running on port 8080. On iPhones, the server runs in port 80, so for http the port can usually be omitted.)		As the interface is designed around a webserver running on the phone, all functions are available as documents below the devices URL. So, this documentation will list all these documents from the document root. For example "/get" can be called as http://192.168.0.42:8080/get (if the phone's IP is 192.168.0.42 and the server is running on port 8080. On iPhones, the server runs in port 80, so for http the port can usually be omitted.)

← Older revision		Revision as of 18:48, 11 September 2016
Line 1:		Line 1:
−	While the remote interface of phyphox is a very powerful tool, you might be interested in communicating and controlling phyphox directly using your own software. The web page called by your browser when using the default remote interface is mostly based on some (not too complex) Javascript code. This code does a range of AJAX requests and receives responses in a JSON format, which are documented on this page.	+	While the [http://phyphox.org/remote-control/ remote interface] of phyphox is a very powerful tool, you might be interested in communicating and controlling phyphox directly using your own software. The web page called by your browser when using the default remote interface is mostly based on some (not too complex) Javascript code. This code does a range of AJAX requests and receives responses in a JSON format, which are documented on this page.

	In principle, with this information, you could embed phyphox into many other projects. For example, you could write an interface to perform measurements including more than one phones with phyphox or you could include phyphox into a more capable measurement software (LabView, Labber, Matlab) or control phyphox alongside other lab equipment like programmable voltage sources or power supplies of electro magnets.		In principle, with this information, you could embed phyphox into many other projects. For example, you could write an interface to perform measurements including more than one phones with phyphox or you could include phyphox into a more capable measurement software (LabView, Labber, Matlab) or control phyphox alongside other lab equipment like programmable voltage sources or power supplies of electro magnets.