Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

Prerequisites

Compatible software Before starting with OpenSpecimen configuration, you need to ensure that the prerequisites below work properly. Note that Krishagni does not provide support in this part since it involves Ziath’s software and it is best to contact them for issues.

Ziath’s scanner software (attached documentation) with CORS support needs to should be installed on the computer attached to box scannerfrom which the user will use OpenSpecimen.

View file
namedp5-api-documentation (4).pdf

Note: Please check with Ziath for latest documentation.

Testing Prerequisites

  1. Validate the API outputs all active/ connected scanners
    E.g. curl --location --request GET 'http://localhost:9998/dp5/remote/v1/scanners' --header 'Origin: https://hosturl'
    This should return list of all attached scanners

  2. Add the scanner via API
    E.g. curl --location --request POST 'http://localhost:9998/dp5/remote/v1/scan?container_uid=1'--header 'Origin: https://hosturl'
    This should return the scan result, or the raw image from the scan

Info
  1. The above commands should be executed from the system where DP5 software is installed.

  2. Syntax may vary depending on Linux/Windows system and the region

Inputs needed from client

Field Name

Description

Type of scanner

ziath_dp5

ContainerUid

There could be multiple scanners served by the same software/server. Each scanner is identified by a unique ID.

Port number from localhost/ URL for communicating with the scanner

E.g. 8001, 8777, http://localhost:9998/

...

Configuring OpenSpecimen