R4 heating module
Note
Serial connection parameters
Note, further parameters for the serial connections (i.e. those accepted by serial.Serial) such as baudrate,
parity, stopbits and bytesize can be specified.
However, it should not be necessary as the following values (which are the default for the instrument) are
automatically used:
timeout 0.1s
baudrate 19200
parity none
stopbits 1
bytesize 8
API methods
Once configured, a flowchem R4Heater object will expose the following commands:
- GET /r4-heater-1/reactor1/temperature
Get Temperature
Return temperature in Celsius.
- Status Codes
200 OK – Successful Response
- PUT /r4-heater-1/reactor1/temperature
Set Temperature
Set the target temperature to the given string in natural language.
- Query Parameters
temp (string) – (Required)
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- PUT /r4-heater-1/reactor1/power-on
Power On
Turn on temperature control.
- Status Codes
200 OK – Successful Response
- PUT /r4-heater-1/reactor1/power-off
Power Off
Turn off temperature control.
- Status Codes
200 OK – Successful Response
- GET /r4-heater-1/reactor1/target-reached
Is Target Reached
Return True if the set temperature target has been reached.
- Status Codes
200 OK – Successful Response
- GET /r4-heater-1/reactor1/limits
Temperature Limits
Return a dict with min and max temperature in Celsius.
- Status Codes
200 OK – Successful Response
- GET /r4-heater-1/reactor2/temperature
Get Temperature
Return temperature in Celsius.
- Status Codes
200 OK – Successful Response
- PUT /r4-heater-1/reactor2/temperature
Set Temperature
Set the target temperature to the given string in natural language.
- Query Parameters
temp (string) – (Required)
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- PUT /r4-heater-1/reactor2/power-on
Power On
Turn on temperature control.
- Status Codes
200 OK – Successful Response
- PUT /r4-heater-1/reactor2/power-off
Power Off
Turn off temperature control.
- Status Codes
200 OK – Successful Response
- GET /r4-heater-1/reactor2/target-reached
Is Target Reached
Return True if the set temperature target has been reached.
- Status Codes
200 OK – Successful Response
- GET /r4-heater-1/reactor2/limits
Temperature Limits
Return a dict with min and max temperature in Celsius.
- Status Codes
200 OK – Successful Response
- GET /r4-heater-1/reactor3/temperature
Get Temperature
Return temperature in Celsius.
- Status Codes
200 OK – Successful Response
- PUT /r4-heater-1/reactor3/temperature
Set Temperature
Set the target temperature to the given string in natural language.
- Query Parameters
temp (string) – (Required)
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- PUT /r4-heater-1/reactor3/power-on
Power On
Turn on temperature control.
- Status Codes
200 OK – Successful Response
- PUT /r4-heater-1/reactor3/power-off
Power Off
Turn off temperature control.
- Status Codes
200 OK – Successful Response
- GET /r4-heater-1/reactor3/target-reached
Is Target Reached
Return True if the set temperature target has been reached.
- Status Codes
200 OK – Successful Response
- GET /r4-heater-1/reactor3/limits
Temperature Limits
Return a dict with min and max temperature in Celsius.
- Status Codes
200 OK – Successful Response
- GET /r4-heater-1/reactor4/temperature
Get Temperature
Return temperature in Celsius.
- Status Codes
200 OK – Successful Response
- PUT /r4-heater-1/reactor4/temperature
Set Temperature
Set the target temperature to the given string in natural language.
- Query Parameters
temp (string) – (Required)
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- PUT /r4-heater-1/reactor4/power-on
Power On
Turn on temperature control.
- Status Codes
200 OK – Successful Response
- PUT /r4-heater-1/reactor4/power-off
Power Off
Turn off temperature control.
- Status Codes
200 OK – Successful Response