Commit 0f37d2fd authored by reza's avatar reza

Update README.md

parent 7ef2378d
...@@ -28,7 +28,7 @@ clr.AddReference(the absolute path of i8.dll file) ...@@ -28,7 +28,7 @@ clr.AddReference(the absolute path of i8.dll file)
### Instance from main class of i8devices ### Instance from main class of i8devices
Just import `Device` class, And then you can use it by declaring an instance of `Device` class. Just import `Device` class, And then you can use it by declaring an instance of `Device` class.
``` ```
from I8Devices import Device from I8Devices import Device, Settings
myAwsomeHolyShitImDyingForThisDevice = Device() myAwsomeHolyShitImDyingForThisDevice = Device()
``` ```
...@@ -82,10 +82,26 @@ Right after calling this method, the device will go in 'gathering mode' and star ...@@ -82,10 +82,26 @@ Right after calling this method, the device will go in 'gathering mode' and star
Right after calling this method, the device will stop acquiring data. Right after calling this method, the device will stop acquiring data.
#### getData() #### getData()
This method gives you an amount of "gathered samples" depend on where and when you call it. This method gives you an amount of "gathered samples" depend on where and when you call it.
If you call this method with no input in the middle of data gathering, it will return all of buffer If you call this method with no input in the middle of data gathering, it will return all of buffer
and if buffer is empty it will wait untill at least one sample arrives. and if buffer is empty it will wait untill at least one sample arrives.
If you call this method with a number of samples you want (n), in the middle of data gathering, it will return the very last n samples
of buffer and if samples in buffer are less than 'n', it will wait until length of buffer be equal to 'n'.
Note that this method will remove all of buffer after return.
### Setting
For changing settings of the device you should create an instance of class `Settings`
```
mysetting = Settings()
mysetting.test_signal = True
mysetting.sampling_rate = 2000
mysetting.channels_on[7] = False
mysetting.gain = 24
print(myAwsomeHolyShitImDyingForThisDevice.writeSetting(mysetting))
```
## Built With ## Built With
* [C# dll .net](https://docs.microsoft.com/en-us/dotnet/api/system.io.ports.serialport.pinchanged?view=netframework-4.8) * [C# dll .net](https://docs.microsoft.com/en-us/dotnet/api/system.io.ports.serialport.pinchanged?view=netframework-4.8)
...@@ -94,7 +110,7 @@ and if buffer is empty it will wait untill at least one sample arrives. ...@@ -94,7 +110,7 @@ and if buffer is empty it will wait untill at least one sample arrives.
## Contributing ## Contributing
How you fuckin' dare? No contribution.
### Pull Request Process ### Pull Request Process
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment