Ivan Valkou 5 лет назад
Родитель
Сommit
bc32aeec2a
2 измененных файлов с 61 добавлено и 1 удалено
  1. 1 1
      FreeAPS/Resources/Info.plist
  2. 60 0
      README.md

+ 1 - 1
FreeAPS/Resources/Info.plist

@@ -17,7 +17,7 @@
 	<key>CFBundleShortVersionString</key>
 	<string>$(MARKETING_VERSION)</string>
 	<key>CFBundleVersion</key>
-	<string>225</string>
+	<string>229</string>
 	<key>LSApplicationQueriesSchemes</key>
 	<array>
 		<string>dexcomg6</string>

+ 60 - 0
README.md

@@ -1,2 +1,62 @@
 # FreeAPS X
 
+FreeAPS X - an artificial pancreas system for iOS based on [OpenAPS Reference](https://github.com/openaps/oref0) algorithms
+
+[OpenAPS documentation](https://openaps.readthedocs.io/en/latest/)
+
+FreeAPS X uses original JavaScript files of oref0 and provides a user interface (UI) to control and set up the system
+
+## Smartphone requirements
+
+- All iPhones which support iOS 14 and up.
+
+## Supported pumps
+
+To control an insulin pump FreeAPS X uses modified [rileylink_ios](https://github.com/ps2/rileylink_ios) library, thus supporting the same pump list:
+
+- Medtronic 515 or 715 (any firmware)
+- Medtronic 522 or 722 (any firmware)
+- Medtronic 523 or 723 (firmware 2.4 or lower)
+- Medtronic Worldwide Veo 554 or 754 (firmware 2.6A or lower)
+- Medtronic Canadian/Australian Veo 554 or 754 (firmware 2.7A or lower)
+- Omnipod "Eros" pods
+
+To control an insulin you need to have a [RileyLink](https://getrileylink.org), oRange, Pickle, GNARL, Emalink or similar device
+
+## Current state of FreeAPS X
+
+FreeAPS X is in an active development state
+
+**We do not recomment to use the system for everyday control of blood glucose**
+
+If you want to test it, there is a beta-version available
+
+## Implemented in version 0.1.0 (Beta)
+
+- All base functions of oref0
+- All base functions of oref1 (SMB, UAM and others)
+- Autotune
+- Autosens
+- Nightscout BG data source as a CGM (Online)
+- Applications that mimic Nightscout as a CGM (apps like Spike and Diabox) (Offline)
+- System state upload to Nightscout
+- Remote carbs enter and temporary targets through Nightscout
+
+## Not implemented (plans for future)
+
+- Open loop mode
+- Phone notifications of the system state
+- Bolus cancelation possibility
+- Profile upload to Nightscout
+- Desktop widget
+- Apple Watch app
+- Remote bolusing and insulin pump control
+- Plugins
+- Dexcom support
+- Apple Health support
+- Detailed functions description inside the app
+
+## Documentation
+
+*In progress*
+