Commit eaedc3d8 authored by reza's avatar reza

Update README.md

parent 976ff874
Pipeline #70 failed with stages
......@@ -21,16 +21,16 @@ pip install numpy
pip install pythonnet
```
### import dll file
### Import dll file
After installing the requrment packages, import ".net for python" (clr) and make a reference (copy) of the .dll file with this commands:
After installing the requrment packages, import ".net for python" (clr) and make a reference (copy) of the .dll file with thess commands:
```
import clr
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')
```
### 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.
```
from I8Devices import Device
......@@ -40,37 +40,42 @@ myAwsomeHolyShitImDyingForThisDevice = Device()
## 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` (it should be installed itself if your connected to internet).
After that type in the `connecting` method
After that type in the `Connect` method
```
myAwsomeHolyShitImDyingForThisDevice.ConnectToDevice()
myAwsomeHolyShitImDyingForThisDevice.Connect()
```
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:
If device is successfully connected to the PC, you can use the following methods and properties to retrieve Device information, or send a command/ recieve data to/from the device:
```
# Info
myDevice.name
myAwsomeHolyShitImDyingForThisDevice.name
myAwsomeHolyShitImDyingForThisDevice.channelsnumber
myAwsomeHolyShitImDyingForThisDevice.info
myAwsomeHolyShitImDyingForThisDevice.ReadStatus()
# get data
myDevice.StartDataAcquisition()
myDevice.get_data()
myDevice.StoptDataAcquisition()
myAwsomeHolyShitImDyingForThisDevice.Start()
myAwsomeHolyShitImDyingForThisDevice.GetData()
myAwsomeHolyShitImDyingForThisDevice.Stop()
myAwsomeHolyShitImDyingForThisDevice.Leadoff()
# write setting
myAwsomeHolyShitImDyingForThisDevice.Set()
```
## 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)
* [numpy](https://pypi.org/project/numpy/) - Used to calculate some shit
* [scipy](https://pypi.org/project/scipy/) - Used to calculate some real shit
## Contributing
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
How you fuckin' dare?
### Pull Request Process
......@@ -93,4 +98,4 @@ We use [SemVer](http://semver.org/) for versioning. The current released version
## License
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
This project is licensed under the I8 Co. License - see the [Infinite8 website](https://infinite8.tech) for details. (you wish there will be some information but I gotta tell you there is not )
\ 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