Index: README.md =================================================================== diff -u -r6114b6cad910ab91431069062054e4a549c56400 -rb0c5cfc6618b44d337ad6560f2cb4252e68c8d8c --- README.md (.../README.md) (revision 6114b6cad910ab91431069062054e4a549c56400) +++ README.md (.../README.md) (revision b0c5cfc6618b44d337ad6560f2cb4252e68c8d8c) @@ -6,41 +6,46 @@ It supports the Systems level testing, Software Verification & Validation, and pre-release SW and FW developmental testing by exposing and simulating interaction with the UI, HD, and DG sub-components. -Cross functional team members may install this API from pre-packaged binary files that are hosted locally on Diality servers. Once installed to their local -development environment with pip, they have access to a wide array of testing capabilities. -All distribution packages are to be versioned so backwards compatibility is maintained and API updates can continue without affecting -the users. After installation, users may import modules from the API as needed and run their automation tests. +To use this API, it is recommended to install the API directly from this locally hosted git repository. +It is also possible to install it from a pre-packaged .whl file. Once installed to your local +virtual python environment with pip, you can import modules as needed to develop your tests. +All released versions of this API will be officially versioned so backwards compatibility is maintained and API updates can continue without affecting +day-to-day testing. -Please note that the structure of this repository is still under review and the architecture is likely to change as improvements are made. +Please understand that the structure of this repository is still under review and the architecture is likely to change as improvements are made. ## Using the API ### Install directly from this repository -- Your ssh key has already been setup with our internal BitBucket servers -- Your computer must be in the office or you must be on VPN +- Assumes your ssh key has already been setup with our internal BitBucket servers +- Assumes your computer is in the office or that you are on the VPN -How to install from the master branch (Not yet available) -- Will be possible as soon as the dialin_refactoring_3 branch has been merged with the master branch +How to install from the dialin_refactoring_3 branch (Available) ``` #!/bin/bash virtualenv --python=python3 venv source venv/bin/activate -pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git +branch="dialin_refactoring_3" +pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git@$branch ``` -How to install from the dialin_refactoring_3 branch (Available) +All release versions will eventually be placed on their own separate branch to facilitate +backwards compatibility and a fully accessible and testable API version history. + +How to install from the master branch (Not yet available) +- Will be possible as soon as the dialin_refactoring_3 branch has been merged with the master branch + ``` #!/bin/bash virtualenv --python=python3 venv source venv/bin/activate -branch="dialin_refactoring_3" -pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git@$branch +pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git ``` ### Install from a pre-built .whl file: @@ -53,6 +58,48 @@ pip3 install dialin-0.0.1-py3-none-any.whl ``` + +### Modules + +- See the tests directory for examples of how to use this API +- Also consult the Dialin API documentation which can be generated using the `tools/document.sh` script. + +```batch +from dialin.hd.basics import HDBasics +from dialin.hd.alarms import HDAlarms +from dialin.hd.constants import RESET, NO_RESET +from dialin.hd.buttons import HDButtons +from dialin.hd.blood_flow import HDBloodFlow +from dialin.hd.hemodialysis_device import HD +from dialin.hd.dialysate_outlet_flow import HDDialysateOutletFlow +from dialin.hd.dialysate_inlet_flow import HDDialysateInletFlow +from dialin.hd.dialout_flow import DialOutStates, HDDialOut +from dialin.hd.ui import HDUI +from dialin.hd.treatment import HDTreatment +from dialin.hd.rtc import HDRTC +from dialin.hd.watchdog import HDWatchdog +from dialin.hd.basics import HDBasics +from dialin.hd.pressure_occlusion import HDPressureOcclusion + + +from dialin.dg.dialysate_generator import DG + + +from dialin.protocols.CAN import (DenaliCanMessenger, + DenaliMessage, + DenaliChannels, + LongDenaliMessageBuilder) + + +from dialin.utils.conversions import (integer_to_bytearray, + float_to_bytearray) + + + +``` + + + ## Dialin API Internal Development Environment ### Linux