Introduction

Overview

• generel commands
• bluetooth commands
• database commands

Generel commands

Info

• The number 0 stands for the live image, 1 for the left and 2 for the right integrated image.Number 3 stands for a retrieved image.
• [something] denotes an optional input for "something"
• a|b an alternative.

Bluetooth commands

• btconnect [<device_name>]
  • Connect to the only device available or to the device specified
  • If the device is not paired yet, it will be paired before
• btdisconnect
  • End current connection
  • The device keeps paired
• btremove [<device_name>]
  • Remove the device given by <device_name> from the paired devices
  • If <device_name> is not given, all devices whose name starts with "SmartCover" will be removed
  • The usage of this command is recommended in any case of connection failure with the following steps:
    • Inform user about the connection failure (The reason usually is unimportant.)
    • Ask user if he wants to retry
    • Send btremove (If the user wants to retry)
    • Send btconect again
• btversion
  • Query version of internal Bluetooth agent
  • A version change could affect the btevent's

Database commands

• sql <SQL command>
  • Commands to handle sessions
  • This command returns the wsevent "sqlresult" with the key "rows" whose value is an array of the rows returned by the SQL command
  • Each row is an object with the column names as keys. In case of a NULL value the corresponding key is missing
• session <subcommand> ...
  • Execute the given SQL command
  • Fittings are organized in sessions. Every session has a number of recordings
  • A session must be started before a recording can be stored
  • The subcommands:
    • start <client_id>|<client_info>
      • tart a new session for the client with <client_id>
      • Start a new session for a new client specified by <client_info>
      • <client_info> is a JSON object string with the keys 'forename', 'surname' and 'email'. Non of these keys is mandatory
      • Usually it is not a good idea to store a client without any of these data because the only way to find him again will be the autmatically generated timestamp
      • The client_id of the new client can be retrieved by SELECT next_id-1 AS client_id FROM nextids WHERE table_name = 'clients'
      • Both versions create a new row in the sessions table. The session_id can be retrieved by SELECT next_id-1 AS session_id FROM nextids WHERE table_name = 'sessions'
    • finish
      • Finish the current session
      • Finishing a session means checking for unsaved recordings and deleting empty sessions. (sessions without any recordings)
      • Attention! The application server cannot know about unsaved data on the client (product, product_label or notes)
    • restart <session_id>
      • Restart an earlier session
      • This can be useful if the fitter wants to resume an earier session that was not completely successful
    • retrieve <session_id>
      • Fetch 1st and last recording of a session from the database and send images, results and notes
      • The notes (product, product_label, notes) will be packed as additional keys to the result objects
• recording <subcommand> ...
  • Commands concerning a recording
  • The subcommands:
    • store 1|2 [<infos>]
      • Store last recording results (pressure values and analysis results) from the given channel
      • The optional <infos> is a JSON object string with the keys 'product', 'product_label' and 'notes'.
      • If the recording was already stored only the infos will be updated
    • cancel [1|2]
      • Cancels recording 1 or recording 2 respectively
      • If no recording is specified both recordings will be cancelled
      • This is useful if the user explicitly wants to cancel a recording before starting a new one
      • To implicitly cancel an unstored recording use the -force option of the record command
    • retrieve <recording_id> [1|2|3]
      • etch recording with <recording_id> from the database
      • The notes (product, product_label, notes) will be packed as additional keys to the result object
      • If a channel is given, the image and the results are for that channel
      • If the destination channel holds an unstored recording an error message will be returned
      • Use record cancel or record store to clear this problem.
      • If no channel is given, the image will be created in "session compare mode", i.e. the (red) maximum shows the maxiumum pressure of the whole session.
• analysis {<blocks> [<session_id>] | <analyses>}
  • Storing and retrieving unique¹⁾ analysis results during a session
  • These results may come from measurements or may be results of an inquiry.
  • There are the following types (blocks) of results:
  • ¹⁾ unique within a session

    block	contains
    sitbones	Result of sitbone analysis
    	(currently of visual analysis of sitbones pressure image)
    anamnesis	Result of anamnesis
    	(see get appquestions)
    x1	1st result set defined by client application
    x2	2nd result set ...
    ...	(numbering 1 ...)

  • The complete syntax is as follows:
  analysis {<blocks> [<session_id>] | <analyses>}

  • <blocks>:	JSON-array containing the block codes for retrieve
    <session_id>:	... the results belong to
    	(Default is the active session.)
    <analyses>:	JSON-object containing all the results to be stored

• get mask ...
• get appquestions ...

The recording results

Pelvis rotation

                    v-Secondary axis
                    | c1               | front                  | c2
                   -+------------------+------------------------+- Front tangent
                    |                  |                        |
                    |                  |                        |
                    |                  |                        |
                    | left             | center                 | right
                   -+------------------+------------------------+- <-Principal axis
                    |                  |                        |
                    |                  |                        |
                    | c4               | rear                   | c3
                   -+------------------+------------------------+- Rear tangent
                    |                  |                        |
                    Left tangent                                Right tangent
                

Veloscore

JSON responses

Error classes and numbers:

Stored settings

Fetching JPEG-Images

Hints to client application developers

• numeric value
• yes/no answer
• numeric value from defaults
• string value from defaults