|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SDK
This interface was developed to provide an easy-to-use component for the communication with medical devices. These devices have to be bound with the system / the application in order to communicate with them or to receive measurement data from them.
Field Summary | |
---|---|
static int |
DATETIME
Ease-of-use constant for the SDK methods getDeviceConfigurations() ,
getDeviceConfigurationsAndWait() ,
setDeviceConfigurations() or
setDeviceConfigurationsAndWait() . |
static int |
DEVICE_STATUS
Ease-of-use constant for the SDK methods getDeviceConfigurations() ,
getDeviceConfigurationsAndWait() ,
setDeviceConfigurations() or
setDeviceConfigurationsAndWait() . |
static short |
DEVICE_TYPE_BLOOD_GLUCOSE
Type constant that represents a special type of a medical device. |
static short |
DEVICE_TYPE_BLOOD_PRESSURE
Type constant that represents a special type of a medical device. |
static short |
DEVICE_TYPE_SCALE
Type constant that represents a special type of a medical device. |
static int |
FIRMWARE
Ease-of-use constant for the SDK methods getDeviceConfigurations() ,
getDeviceConfigurationsAndWait() ,
setDeviceConfigurations() or
setDeviceConfigurationsAndWait() . |
static int |
IEEE_ADDRESS
Ease-of-use constant for the SDK methods getDeviceConfigurations() ,
getDeviceConfigurationsAndWait() ,
setDeviceConfigurations() or
setDeviceConfigurationsAndWait() . |
static int |
SERIAL_NUMBER
Ease-of-use constant for the SDK methods getDeviceConfigurations() ,
getDeviceConfigurationsAndWait() ,
setDeviceConfigurations() or
setDeviceConfigurationsAndWait() . |
static int |
USER_SETTING
Ease-of-use constant for the SDK methods getDeviceConfigurations() ,
getDeviceConfigurationsAndWait() ,
setDeviceConfigurations() or
setDeviceConfigurationsAndWait() . |
Method Summary | |
---|---|
void |
addSDKDataListener(SDKDataListener listener)
Adds the specified data listener to receive data events of the devices. |
void |
addSDKDevicesListener(SDKDevicesListener listener)
Adds the specified devices listener to receive device events. |
void |
addSDKErrorListener(SDKErrorListener listener)
Adds the specified error listener to receive sdk error events. |
void |
addSDKListener(SDKListener listener)
Adds the specified sdk listener to receive general sdk events. |
void |
bindAllUnboundDevices()
Binds all unbound devices. |
boolean |
bindDevice(MedicalDeviceTO medicalDevice)
Binds a single unbound device. |
boolean |
bindDevices(java.util.List<MedicalDeviceTO> medicalDevices)
Binds a list of unbound devices. |
void |
clearBindingActions()
Clears the binding actions for all types of devices. |
void |
clearUnbindingActions()
Clears the unbinding actions for all types of devices. |
void |
exit()
Exits the sdk and waits for it. |
void |
exitAndWait()
Exits the sdk. |
AutoUpdatePolicy |
getBoundAutoUpdatePolicy()
Returns the current automatic update configuration for bound devices. |
boolean |
getDeviceConfigurations(MedicalDeviceTO medicalDevice,
int configurations)
Requests information of the specified device. |
MedicalDeviceTO |
getDeviceConfigurationsAndWait(MedicalDeviceTO medicalDevice,
int configurations)
Requests information of the specified device. |
boolean |
getDeviceData(MedicalDeviceTO medicalDevice)
Requests the stored measurement data of the specified device. |
SDKState |
getState()
Returns the current state of the sdk. |
AutoUpdatePolicy |
getUnboundAutoUpdatePolicy()
Returns the current automatic update configuration for unbound devices. |
boolean |
getUserParameters(MedicalDeviceTO medicalDevice,
TO userParameters)
Requests user parameters of the specified device. |
TO |
getUserParametersAndWait(MedicalDeviceTO medicalDevice,
TO userParameters)
Requests user parameters of the specified device. |
void |
removeSDKDataListener(SDKDataListener listener)
Removes the specified data listener so that it no longer receives data events. |
void |
removeSDKDevicesListener(SDKDevicesListener listener)
Removes the specified devices listener so that it no longer receives device events. |
void |
removeSDKErrorListener(SDKErrorListener listener)
Removes the specified error listener so that it no longer receives error events. |
void |
removeSDKListener(SDKListener listener)
Removes the specified sdk listener so that it no longer receives sdk events. |
void |
setBindingAction(SDKAction action)
Defines a binding action. |
void |
setBindingAction(SDKAction action,
int deviceType)
Defines a binding action for the specified device type. |
void |
setBoundAutoUpdatePolicy(AutoUpdatePolicy autoUpdatePolicy)
Defines the automatic update policy of missing device information for bound devices. |
boolean |
setDeviceClearMem(MedicalDeviceTO medicalDevice)
Clears the memory of the specified device. |
MedicalDeviceTO |
setDeviceClearMemAndWait(MedicalDeviceTO medicalDevice)
Clears the memory of the specified device. |
boolean |
setDeviceConfigurations(MedicalDeviceTO medicalDevice,
int configurations)
Writes information to the specified device. |
MedicalDeviceTO |
setDeviceConfigurationsAndWait(MedicalDeviceTO medicalDevice,
int configurations)
Writes information to the specified device. |
void |
setUnbindingAction(SDKAction action)
Defines an unbinding action. |
void |
setUnbindingAction(SDKAction action,
int deviceType)
Defines an unbinding action for the specified device type. |
void |
setUnboundAutoUpdatePolicy(AutoUpdatePolicy autoUpdatePolicy)
Defines the automatic update policy of missing device information for unbound devices. |
boolean |
setUserParameters(MedicalDeviceTO medicalDevice,
TO userParameters)
Writes user parameters to the specified device. |
TO |
setUserParametersAndWait(MedicalDeviceTO medicalDevice,
TO userParameters)
Writes information to the specified device. |
void |
start()
Starts the sdk. |
void |
startAndWait()
Starts the sdk and waits for it. |
void |
unbindAllBoundDevices()
Unbinds all bound devices. |
boolean |
unbindDevice(MedicalDeviceTO medicalDevice)
Unbinds a single bound device. |
boolean |
unbindDevices(java.util.List<MedicalDeviceTO> medicalDevices)
Unbinds a list of bound devices. |
Field Detail |
---|
static final int DATETIME
getDeviceConfigurations()
,
getDeviceConfigurationsAndWait()
,
setDeviceConfigurations()
or
setDeviceConfigurationsAndWait()
.
getDeviceConfigurations(MedicalDeviceTO, int)
,
getDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
setDeviceConfigurations(MedicalDeviceTO, int)
,
setDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
Constant Field Valuesstatic final int SERIAL_NUMBER
getDeviceConfigurations()
,
getDeviceConfigurationsAndWait()
,
setDeviceConfigurations()
or
setDeviceConfigurationsAndWait()
.
getDeviceConfigurations(MedicalDeviceTO, int)
,
getDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
setDeviceConfigurations(MedicalDeviceTO, int)
,
setDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
Constant Field Valuesstatic final int FIRMWARE
getDeviceConfigurations()
,
getDeviceConfigurationsAndWait()
,
setDeviceConfigurations()
or
setDeviceConfigurationsAndWait()
.
getDeviceConfigurations(MedicalDeviceTO, int)
,
getDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
setDeviceConfigurations(MedicalDeviceTO, int)
,
setDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
Constant Field Valuesstatic final int IEEE_ADDRESS
getDeviceConfigurations()
,
getDeviceConfigurationsAndWait()
,
setDeviceConfigurations()
or
setDeviceConfigurationsAndWait()
.
getDeviceConfigurations(MedicalDeviceTO, int)
,
getDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
setDeviceConfigurations(MedicalDeviceTO, int)
,
setDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
Constant Field Valuesstatic final int USER_SETTING
getDeviceConfigurations()
,
getDeviceConfigurationsAndWait()
,
setDeviceConfigurations()
or
setDeviceConfigurationsAndWait()
.
getDeviceConfigurations(MedicalDeviceTO, int)
,
getDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
setDeviceConfigurations(MedicalDeviceTO, int)
,
setDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
Constant Field Valuesstatic final int DEVICE_STATUS
getDeviceConfigurations()
,
getDeviceConfigurationsAndWait()
,
setDeviceConfigurations()
or
setDeviceConfigurationsAndWait()
.
getDeviceConfigurations(MedicalDeviceTO, int)
,
getDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
setDeviceConfigurations(MedicalDeviceTO, int)
,
setDeviceConfigurationsAndWait(MedicalDeviceTO, int)
,
Constant Field Valuesstatic final short DEVICE_TYPE_BLOOD_PRESSURE
setBindingAction()
and
setUnbindingAction(()
.
setBindingAction(SDKAction)
,
setBindingAction(SDKAction, int)
,
setUnbindingAction(SDKAction)
,
setUnbindingAction(SDKAction, int)
,
Constant Field Valuesstatic final short DEVICE_TYPE_BLOOD_GLUCOSE
setBindingAction()
and
setUnbindingAction(()
.
setBindingAction(SDKAction)
,
setBindingAction(SDKAction, int)
,
setUnbindingAction(SDKAction)
,
setUnbindingAction(SDKAction, int)
,
Constant Field Valuesstatic final short DEVICE_TYPE_SCALE
setBindingAction()
and
setUnbindingAction(()
.
setBindingAction(SDKAction)
,
setBindingAction(SDKAction, int)
,
setUnbindingAction(SDKAction)
,
setUnbindingAction(SDKAction, int)
,
Constant Field ValuesMethod Detail |
---|
void addSDKListener(SDKListener listener)
listener
- the sdk listener.void removeSDKListener(SDKListener listener)
listener
- the sdk listenervoid addSDKDevicesListener(SDKDevicesListener listener)
listener
- the devices listenervoid removeSDKDevicesListener(SDKDevicesListener listener)
listener
- the devices listenervoid addSDKDataListener(SDKDataListener listener)
listener
- the data listenervoid removeSDKDataListener(SDKDataListener listener)
listener
- the data listenervoid addSDKErrorListener(SDKErrorListener listener)
listener
- the error listenervoid removeSDKErrorListener(SDKErrorListener listener)
listener
- the error listenervoid start()
startAndWait()
has to be called before using the sdk.onStarted()
of the listener
SDKListener
is fired. In case of an error the event
onStartError()
of the SDKErrorListener
is fired.startAndWait()
instead if you need a
synchronous behavior of this function.
void startAndWait() throws SDKStartException
start()
has to be called before using the sdk.onStartError()
of the SDKErrorListener
is fired and a SDKStartException
is thrown.start()
instead if you need a
asynchronous behavior of this function.
SDKStartException
- if an error occurs while starting the sdkvoid exit()
exitAndWait()
has to be called after using the sdk.onExited()
of the listener
SDKListener
is fired. In case of an error the event
onExitError()
of the SDKErrorListener
is fired.exitAndWait()
instead if you need a
synchronous behavior of this function.
void exitAndWait() throws SDKExitException
exit()
has to be called after using the sdk.onExitError()
of the SDKErrorListener
is fired and a SDKExitException
is thrown.exit()
instead if you need a
asynchronous behavior of this function.
SDKExitException
- if an error occurs while exiting the sdkSDKState getState()
SDKState.STARTED
the sdk can be used.
boolean bindDevice(MedicalDeviceTO medicalDevice)
medicalDevice
- the medical device description
boolean bindDevices(java.util.List<MedicalDeviceTO> medicalDevices)
medicalDevices
- a list of medical device descriptions
void bindAllUnboundDevices()
boolean unbindDevice(MedicalDeviceTO medicalDevice)
medicalDevice
- the medical device description
boolean unbindDevices(java.util.List<MedicalDeviceTO> medicalDevices)
medicalDevices
- a list of medical device descriptions
void unbindAllBoundDevices()
boolean getDeviceConfigurations(MedicalDeviceTO medicalDevice, int configurations)
getDeviceConfigurationsAndWait
instead if you need a
synchronous behavior of this function.
medicalDevice
- the medical device description. Only the parameter
deviceId is used.configurations
- the configurations to request. Use the constants
SDK.DATETIME
, SDK.SERIAL_NUMBER
,
SDK.FIRMWARE
, SDK.IEEE_MAC_ADDRESS
,
USER_SETTINGS
or combinations with bit-or (|
)
to specify the configurations.
MedicalDeviceTO getDeviceConfigurationsAndWait(MedicalDeviceTO medicalDevice, int configurations) throws SDKDeviceException
getDeviceConfigurations
instead if you need a
asynchronous behavior of this function.
medicalDevice
- the medical device description. Only the parameter
deviceId is used.configurations
- the configurations to request. Use the constants
SDK.DATETIME
, SDK.SERIAL_NUMBER
,
SDK.FIRMWARE
, SDK.IEEE_MAC_ADDRESS
,
USER_SETTINGS
or combinations with bit-or (|
)
to specify the configurations.
SDKDeviceException
- if a communication error occurs.boolean setDeviceConfigurations(MedicalDeviceTO medicalDevice, int configurations)
setDeviceConfigurationsAndWait
instead if you need a
synchronous behavior of this function.
medicalDevice
- the medical device description.configurations
- the configurations to request. Use the constants
SDK.DATETIME
, SDK.SERIAL_NUMBER
,
SDK.FIRMWARE
, SDK.IEEE_MAC_ADDRESS
,
USER_SETTINGS
or combinations with bit-or (|
)
to specify the configurations.
MedicalDeviceTO setDeviceConfigurationsAndWait(MedicalDeviceTO medicalDevice, int configurations) throws SDKDeviceException
setDeviceConfigurations
instead if you need a
asynchronous behavior of this function.
medicalDevice
- the medical device description.configurations
- the configurations to request. Use the constants
SDK.DATETIME
, SDK.SERIAL_NUMBER
,
SDK.FIRMWARE
, SDK.IEEE_MAC_ADDRESS
,
USER_SETTINGS
or combinations with bit-or (|
)
to specify the configurations.
SDKDeviceException
- if a communication error occurs.boolean getUserParameters(MedicalDeviceTO medicalDevice, TO userParameters)
getUserParametersAndWait
instead if you need a
synchronous behavior of this function.
Note: Not all devices support this function! At this time
only scales support it.
medicalDevice
- the medical device description. Only the parameter
deviceId is used.userParameters
- the user parameters. Only the parameter userIndex
is used.
TO getUserParametersAndWait(MedicalDeviceTO medicalDevice, TO userParameters) throws SDKDeviceException
getUserParameters
instead if you need a
asynchronous behavior of this function.
medicalDevice
- the medical device description. Only the parameter
deviceId is used.userParameters
- the user parameters. Only the parameter userIndex
is used.
SDKDeviceException
- if a communication error occurs.boolean setUserParameters(MedicalDeviceTO medicalDevice, TO userParameters)
setUserParametersAndWait
instead if you need a
synchronous behavior of this function.
medicalDevice
- the medical device description. Only the parameter
deviceId is used.userParameters
- the user parameters
TO setUserParametersAndWait(MedicalDeviceTO medicalDevice, TO userParameters) throws SDKDeviceException
SetDeviceConfigurations
instead if you need a
asynchronous behavior of this function.
medicalDevice
- the medical device description. Only the parameter
deviceId is used.userParameters
- the user parameters.
SDKDeviceException
- if a communication error occurs.boolean setDeviceClearMem(MedicalDeviceTO medicalDevice)
setDeviceClearMemAndWait
instead if you need a
synchronous behavior of this function.
medicalDevice
- the medical device description. Only the parameter
deviceId is used.
MedicalDeviceTO setDeviceClearMemAndWait(MedicalDeviceTO medicalDevice) throws SDKDeviceException
setDeviceClearMem
instead if you need a
asynchronous behavior of this function.
medicalDevice
- the medical device description. Only the parameter
deviceId is used.
SDKDeviceException
- if a communication error occurs.boolean getDeviceData(MedicalDeviceTO medicalDevice)
medicalDevice
- the medical device description. Only the parameter
deviceId is used.
void setBoundAutoUpdatePolicy(AutoUpdatePolicy autoUpdatePolicy)
AutoUpdatePolicy.AUTO_UPDATE_DISABLED
: Disables any
automatic updateAutoUpdatePolicy.AUTO_UPDATE_MISSING_SERIAL_NUMBER
:
Updates only the serial number automatically if it is missing.AutoUpdatePolicy.AUTO_UPDATE_ALL_MISSING_DATA
: Update
all missing devices information automatically.
autoUpdatePolicy
- the auto update policyAutoUpdatePolicy getBoundAutoUpdatePolicy()
void setUnboundAutoUpdatePolicy(AutoUpdatePolicy autoUpdatePolicy)
AutoUpdatePolicy.AUTO_UPDATE_DISABLED
: Disables any
automatic updateAutoUpdatePolicy.AUTO_UPDATE_MISSING_SERIAL_NUMBER
:
Updates only the serial number automatically if it is missing. This
option will temporary bind the device, read the information and unbind
it in case of missing data.AutoUpdatePolicy.AUTO_UPDATE_ALL_MISSING_DATA
: Update
all missing devices information automatically. This option will
temporary bind the device, read the information and unbind it in case of
missing data.
autoUpdatePolicy
- the auto update policyAutoUpdatePolicy getUnboundAutoUpdatePolicy()
void setBindingAction(SDKAction action)
action
- the sdk action.void setBindingAction(SDKAction action, int deviceType)
action
- the sdk action.deviceType
- the device type. Use one of the constants
SDK.DEVICE_TYPE_BLOOD_PRESSURE
,
SDK.DEVICE_TYPE_BLOOD_GLUCOSE
or
SDK.DEVICE_TYPE_SCALE
to define it.void clearBindingActions()
void setUnbindingAction(SDKAction action)
action
- the sdk action.void setUnbindingAction(SDKAction action, int deviceType)
action
- the sdk action.deviceType
- the device type. Use one of the constants
SDK.DEVICE_TYPE_BLOOD_PRESSURE
,
SDK.DEVICE_TYPE_BLOOD_GLUCOSE
or
SDK.DEVICE_TYPE_SCALE
to define it.void clearUnbindingActions()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |