Commit 976ff874 authored by reza's avatar reza

Update README.md

parent 1d808ad3
Pipeline #69 canceled with stages
...@@ -31,71 +31,40 @@ clr.AddReference(the absolute path of i8.dll file) ...@@ -31,71 +31,40 @@ clr.AddReference(the absolute path of i8.dll file)
# for example: clr.AddReference('C:/Users/i8-tech/Desktop/csharp_dlls/infinite8dll/I8Library1/bin/Debug/I8Library1.dll') # for example: clr.AddReference('C:/Users/i8-tech/Desktop/csharp_dlls/infinite8dll/I8Library1/bin/Debug/I8Library1.dll')
``` ```
### 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
myAwsomeHolyShitImDyingForThisDevice = Device()
``` ```
## How to Use ## How to Use
First of all, you should plug your device into your PC, and also install `ST micro COM Port Package` from `Device Manager`. First of all, you should plug your device into your PC, and also install `ST micro COM Port Package` from `Device Manager` (it should be installed itself if your connected to internet).
After that After that type in the `connecting` method
``` ```
file_base = FileBase(subject_id=1, protocol_name='room_1', task_name='SART', sequence="", project='1', description='hi') myAwsomeHolyShitImDyingForThisDevice.ConnectToDevice()
file_base.set_brain_data(raw_data, channel_count, sample_count, sample_rate) # All fields are numeric.
file_base.set_device_data(device_name, software_version, firmware_version, sensor_name) # Use standard patterns like what you can see on the server.
file_base.set_extra_signal(raw_data, channel_count, sample_count, sample_rate) # All fields are numeric.
file_base.set_output_data(raw_data, channel_count, sample_count, sample_rate) # All fields are numeric.
file_base.set_reaction_data(feedback, label, correct_answers)
file_base.save("path:\\to\\place\\you\\want\\to\\save\\file")
``` ```
Use the following methods to retrieve class information: If device is successfully connected to the PC, you can Use the following methods and properties to retrieve Device information or send a command to it:
``` ```
# trial data # Info
file_base.get_subject_id() myDevice.name
file_base.get_protocol_name()
file_base.get_task_name() # get data
file_base.get_description() myDevice.StartDataAcquisition()
file_base.get_sequence() myDevice.get_data()
file_base.get_project() myDevice.StoptDataAcquisition()
file_base.get_timestamp()
file_base.get_filename()
# output data
file_base.get_output_raw_data()
file_base.get_output_channel_count()
file_base.get_output_sample_count()
file_base.get_output_sample_rate()
# extra data
file_base.get_extra_raw_data()
file_base.get_extra_channel_count()
file_base.get_extra_sample_count()
file_base.get_extra_sample_rate()
# brain data
file_base.get_brain_raw_data()
file_base.get_brain_channel_count()
file_base.get_brain_sample_count()
file_base.get_brain_sample_rate()
file_base.get_brain_quality()
# device and sensor
file_base.get_device_info()
file_base.get_sensor_name()
# reaction data
file_base.get_feedback_data()
file_base.get_label_data()
file_base.get_reaction_data()
``` ```
## Built With ## Built With
* [C# dll .net] (https://docs.microsoft.com/en-us/dotnet/api/system.io.ports.serialport.pinchanged?view=netframework-4.8)
* [numpy](https://pypi.org/project/numpy/) - Used to calculate quality of data * [numpy](https://pypi.org/project/numpy/) - Used to calculate some shit
* [scipy](https://pypi.org/project/scipy/) - Used to calculate quality of data * [scipy](https://pypi.org/project/scipy/) - Used to calculate some real shit
## Contributing ## Contributing
...@@ -120,8 +89,8 @@ We use [SemVer](http://semver.org/) for versioning. The current released version ...@@ -120,8 +89,8 @@ We use [SemVer](http://semver.org/) for versioning. The current released version
## Authors ## Authors
* **Mehdi Borjian** - *Initial work* - [Mehdi](http://51.75.64.148/Mehdi) * **Varnos** - *Initial work* - [Varnos](http://51.75.64.148/reza)
## License ## License
This project is licensed under the MIT License - see the [kemitchell.com](https://writing.kemitchell.com/2016/09/21/MIT-License-Line-by-Line.html) website for details. This project is licensed under the I8 Co. License - see the [Infinite8 website](https://infinite8.tech) website for details. (you wish there will be some information but I gotta tell you there is not )
\ No newline at end of file \ No newline at end of file
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