phenobox configuration - Gregor-Mendel-Institute/PhenoBox-System GitHub Wiki

A config file for the phenobox application should look like the following:

[server]
base_address = <addressToYourPhenopipeWebServer>:<port>
auth_endpoint = auth/auth
reauth_endpoint = auth/reauth
graphql_endpoint = graphql
shared_folder_url = smb://<path/to/network/share>
[box]
id = <unique_ID_of_this_box>
;Defines the camera position and type. allowed values: vis.side, vis.top, nir.side, nir.top, ir.side, ir.top, fluo.side,fluo.top
camera_position = <camera_type.camera_position>
measurement_tool = phenobox_v1
;This should be left unchanged for the current version
photo_count = 6

log_file = </path/to/the/logfile>
;The folder where images should be saved to before uploading
local_image_folder = </path/to/image/folder>
shared_folder_mountpoint = </path/to/network/share/mount/point>
[credentials]
;The credentials used by the box to authenticate to the phenopipe webserver
username = <username>
password = <password>

• base_address

  • consists of the IP address/hostname and the port of the server which hosts the phenopipe-web application

• auth_endpoint

  • API endpoint for authentications to gain JWT access and refresh tokens

• reauth_endpoint

  • API endpoint for re-authentication via a JWT refresh token

• graphql_endpoint

  • API endpoint for GraphQL queries to fetch and manipulate data

• shared_folder_url

  • The SMB url pointing to the network share where images should be stored

• id

  • A unique ID to identify this box and be able to inspect which images where taken with which phenobox

• camera_position

  • This is an IAP metadata field
  • Defines the installed camera type and position. Following values are allowed:
    • vis.side and vis.top
      • Normal camera mounted taking photos from the side or top respectively
    • nir.side and nir.top
      • Near infrared camera taking photos from the side or top respectively
    • ir.side and ir.top
      • Infrared camera taking photos from the side or top respectively
    • fluo.side and fluo.top
      • Fluorescence camera taking photos from the side or top respectively

• measurement_tool

  • This is an IAP metadata field
  • Metadata to describe the tool with which the photos were taken

• photo_count

  • Used to set the default number of pictures to take per plant
    • Must not be changed in the current version as there is no support for other counts for now

• log_file

  • The absolute path to the log file the application should write to

• local_image_folder

  • The absolute path to the folder in which all taken images should be stored before uploading

• shared_folder_mountpoint

  • The absolute path to the folder which is the mountpoint of the network share pointed to by shared_folder_url

• username

  • The username which the box should use to authenticate to the phenopipe-web server

• password

  • The password which the box should use to authenticate to the phenopipe-web server