Sharer
v1.0.1
Sharer هو .NET ومكتبة Arduino . يتيح لتطبيق سطح المكتب قراءة/كتابة متغيرات ووظائف المكالمات عن بُعد على Arduino ، باستخدام Protocole Protocole Sarross على اتصال تسلسلي. تم تطوير Sharer في البداية لمشروع Ballcuber (https://ballcuber.github.io) ، لكنها الآن مكتبة مستقلة ؛).
// C#
var connection = new SharerConnection ( "COM3" , 115200 ) ;
connection . Connect ( ) ; ملاحظة: بالنسبة لبعض اللوحات ، مثل Micro و Leonardo ، من الضروري تعيين إشارات RTS و DTR مع خصائص RtsEnable و DtrEnable .
// C# - My Arduino code has a function : int Sum(int a, byte b);
var result = connection . Call ( "Sum" , 10 , 12 ) ;
// result.Status : OK
// result.Type : int
// result.Value : 22 // C# - Read all digital pins : digitalRead(0) to digitalRead(13)
for ( int i = 0 ; i <= 13 ; i ++ ) {
var digitalValue = connection . Call ( "digitalRead" , i ) ;
// digitalValue.Status : OK
// digitalValue.Type : bool
// digitalValue.Value : true or false
} // C# - Definition of all functions
var functions = connection . Functions ;
// functions[0].Name : function name
// functions[0].ReturnType : enum void, int, long, ...
// functions[0].Arguments[0].Name // Name of first argument
// functions[0].Arguments[0].Type // enum void, int, long, ... // C#
connection . WriteVariable ( "myVar" , 15 ) ; // returns true if writting OK // C# - Write simultaneously several variables by passing a List<WriteVariable>()
connection . WriteVariables ( listOfVariablesToWrite ) ; // C# - Definition of all variables
var variables = connection . Variables ;
// variables[0].Name : variable name
// variables[0].Type : enum int, long, ... // C#
var value = connection . ReadVariable ( "myVar" ) ;
// value.Status : OK
// value.Value : 12 // C# - Read simultaneously several variables
var values = connection . ReadVariables ( new string [ ] { "myVar" , "anotherVar" , "yetAnother" } ) ; // C#
var info = connection . GetInfos ( ) ;
// info.Board : Arduino UNO
// info.CPUFrequency : 16000000 (Hz)
// a lot more : info.CPlusPlusVersion, info.FunctionMaxCount, info.VariableMaxCount, ... يمكنك إرسال واستقبال الرسائل الكلاسيكية على المنفذ التسلسلي مع وظائف WriteUserData . أيضًا ، يتم رفع حدث UserDataReceived عند إرسال البيانات بواسطة Arduino.
تحذير: لا يمكن قراءة أو كتابة المتغيرات ووظائف المكالمات في معالج الأحداث UserDataReceived .
// C#
connection . WriteUserData ( "Hello!" ) ;
connection . WriteUserData ( 12.2 ) ;
connection . WriteUserData ( new byte [ ] { 0x12 , 0x25 , 0xFF } ) ;
// Event raised when new user data sent by Arduino
connection . UserDataReceived += UserDataReceived ; // C++ Arduino
# include < Sharer.h >
// A simple function that sums an integer and a byte and return an integer
int Sum ( int a, byte b) {
return a + b;
}
// a simple integer
int myVar = 25 ;
void setup () {
Sharer. init ( 115200 ); // Init Serial communication with 115200 bauds
// Expose this function to Sharer : int Sum(int a, byte b)
Sharer_ShareFunction ( int , Sum, int , a, byte, b);
// Share system functions
Sharer_ShareFunction ( bool , digitalRead, uint8_t , pin);
Sharer_ShareVoid (pinMode, uint8_t , pin);
// Expose this variable to Sharer so that the desktop application can read/write it
Sharer_ShareVariable ( int , myVar);
}
// Run Sharer engine in the main Loop
void loop () {
Sharer. run ();
}ينقسم المشارك إلى مستودعين ، أحدهما لمصادر Arduino والآخر لمصادر .NET
يتوفر Sharer في مدير المكتبة المتاح في Tools/Manage Libraries... فقط ابحث عن Sharer وتثبيت أحدث إصدار.
يرجى تنزيل أرشيف مكتبة Sharer: https://github.com/rufus31415/sharer/release/latest/download/sharer.zip
تم اختبار Sharer مع Arduino Uno و Nano و Mega و Due. قد تعمل مع لوحات أخرى. استخراج حتى تحصل على دليل مشارك في دليل "مكتبات" Arduino: C:Program Files (x86)ArduinolibrariesSharer
يمكنك بعد ذلك الاستمتاع بالأمثلة من خلال إعادة تشغيل Arduino IDE والانتقال إلى File / examples / Sharer .
Sharer.net متاح على Nuget: https://www.nuget.org/packages/sharer/
استخدم سطر الأوامر هذا لتثبيته مع مدير الحزمة:
Install-Package Sharer
يمكن تنزيل تجميع sarer.dll هنا: https://github.com/rufus31415/sharer.net/release/latest/download/sharerasssemblies.zip
يحتوي هذا الأرشيف على Nuget Package Sharer.nupkg و sharer.dll تم تجميعه في إصدار AnyCPU للأهداف التالية:
مثال نماذج Windows يتطلب .NET Framework 3.5. يمكن تنزيله هنا: https://github.com/rufus31415/sharer.net/release/latest/download/sharerwindowsformsexample.zip
يتم تشغيل مثال وحدة التحكم مع .NET Core 3.0. لكنك لا تحتاج إلى أي وقت تشغيل لتنفيذه. أمثلة وحدة التحكم المستقلة متوفرة هنا:
© RUFUS31415 راجع ملف الترخيص للحصول على التفاصيل.
يجب تضمين ملف الرأس <Sharer.h>.
في setup() ، تتم تهيئة Sharer عن طريق تمرير baudrate إلى وظيفة Sharer.init(...) . انها تسمية داخليا Serial.init() مع نفس baudrate.
في وظيفة Function loop() ، يجب استدعاء Sharer.run() . يدير النواة الداخلية لـ Sharer التي تدلل الأوامر المستلمة.
# include < Sharer.h >
void setup () {
Sharer. init ( 115200 );
}
void loop () {
Sharer. run ();
}يمكنك أيضًا تهيئة مشارك مع دفق آخر ، مثل Serial2 of Arduino Due إذا كنت تستخدم Serial2 للتواصل مع تطبيق سطح المكتب:
void setup () {
// Initialize with another Serial interface
Serial2. begin ( 9600 );
Sharer. init (Serial2);
} لإضافة متغير في القائمة المتغيرة المشتركة ، يجب عليك الاتصال بالماكرو Sharer_ShareVariable . حجةها الأولى هي نوع المتغير ، والثاني هو اسمه. يتيح هذا الماكرو أن يكون له مؤشر للمتغير واسمه ونوعه وحجم ذاكرته.
byte myByteVar;
long myLongVar;
int myIntArray[ 2 ];
void setup () {
Sharer. init ( 115200 );
Sharer_ShareVariable (byte, myByteVar);
Sharer_ShareVariable ( long , myLongVar);
Sharer_ShareVariable ( int , myIntArray[ 0 ]);
Sharer_ShareVariable ( int , myIntArray[ 1 ]);
} لإضافة متغير في قائمة الوظائف المشتركة ، يجب عليك الاتصال بـ Macro Sharer_ShareFunction . حجةها الأولى هي النوع الذي تم إرجاعه ، والثاني هو اسمه. يتبع وسيطات الماكرو وسيطة الوظيفة المشتركة بنوعها واسمها. لا يوجد حد في عدد الوسيطة التي يمكنك مشاركتها ، ولكن يجب مشاركة جميع الحجج.
مشاركة طريقة الفصل غير مدعومة ويجب أن تكون الوظائف المشتركة وظائف حرة (وظائف ثابتة غير عضو).
يمكنك مشاركة وظائفك الخاصة ، ولكن جميع وظائف النظام مثل analogread و DigitalRead و DigitalWrite و Millis و ...
int Sum ( int a, byte b) {
return a + b;
}
void setup () {
Sharer. init ( 115200 );
// Share your function to Sharer : int Sum(int a, byte b)
Sharer_ShareFunction ( int , Sum, int , a, byte, b);
// Sharer system functions
Sharer_ShareFunction ( int , analogRead, uint8_t , pin);
Sharer_ShareFunction ( bool , digitalRead, uint8_t , pin);
} وظائف الفراغ هي وظائف بدون نوع إرجاع. يجب عليك الاتصال بـ Macro Sharer_ShareVoid لمشاركة وظيفة الفراغ. الوسيطة الأولى هي اسمها ، تليها نوع واسم كل وسيط.
void TurnLEDOn ( void ) {
pinMode ( 13 , OUTPUT);
digitalWrite ( 13 , true );
}
void SetLEDState ( bool state) {
pinMode ( 13 , OUTPUT);
digitalWrite ( 13 , state);
}
void setup () {
Sharer. init ( 115200 );
// Share your void fuctions
Sharer_ShareVoid (TurnLEDOn);
Sharer_ShareVoid (SetLEDState, bool , state);
// Sharer system void functions
Sharer_ShareVoid (digitalWrite, uint8_t , pin);
}ويرث فئة المشاركة من الدفق ، حتى تتمكن من استخدام الوظائف التالية. من فضلك ، لا تستخدم أبدًا sharer.print () أو sharer.println () أو sharer.write () داخل وظيفة مشتركة ، يتم تجاهل الكتابة.
void loop () {
Sharer. run ();
// gets the number of bytes available in the stream
int available = Sharer. available ();
// reads last reveided byte (-1 if no data to read)
int lastByte = Sharer. read ();
// Empty the stream
Sharer. flush ();
// reads data from the serial buffer until the target is found
// returns, true if data is found
bool found = Sharer. find ( " string to find " );
// Returns the next byte of incoming serial data without removing it from the internal serial buffer
// Successive calls to peek() will return the same character
int nextByte = Sharer. peek ();
// reads characters from the serial buffer into a String
String str = Sharer. readString ();
// Looks for the next valid integer in the incoming serial
int lastInt = Sharer. parseInt ();
lastInt = Sharer. parseInt (SKIP_ALL); // all characters other than digits or a minus sign are ignored when scanning the stream for an integer. This is the default mode
lastInt = Sharer. parseInt (SKIP_NONE); // nothing is skipped, and the stream is not touched unless the first waiting character is valid.
lastInt = Sharer. parseInt (SKIP_WHITESPACE); // only tabs, spaces, line feeds, and carriage returns are skipped.
// returns the first valid floating point number from the Serial buffer
float lastFloat = Sharer. parseFloat ();
lastFloat = Sharer. parseFloat (SKIP_ALL); // all characters other than a minus sign, decimal point, or digits are ignored when scanning the stream for a floating point number. This is the default mode.
lastFloat = Sharer. parseFloat (SKIP_NONE); // Nothing is skipped, and the stream is not touched unless the first waiting character is valid.
lastFloat = Sharer. parseFloat (SKIP_WHITESPACE); // only tabs, spaces, line feeds, and carriage returns are skipped.
// Prints ASCII encoded string
Sharer. print ( 85 ); // sends the string "85"
Sharer. print ( 1.23456 ); // sends the string "1.23"
Sharer. print ( ' N ' ); // sends the string "N"
Sharer. print ( " Hello world. " ); // sends the string "Hello world."
Sharer. print ( 78 , BIN); // sends the string "1001110"
Sharer. print ( 78 , OCT); // sends the string "116"
Sharer. print ( 78 , DEC); // sends the string "78"
Sharer. print ( 78 , HEX); // sends the string "4E"
Sharer. print ( 1.23456 , 0 ); // sends the string "1"
Sharer. print ( 1.23456 , 2 ); // sends the string "1.23"
Sharer. print ( 1.23456 , 4 ); // sends the string "1.2345"
Sharer. println ( " Hello ;) " ); // send the string and a new line "Hello ;)n"
Sharer. println (); // just sends a new line
// Write a single byte
Sharer. write ( 0x12 );
} يمكنك تغيير حدود المشاركة عن طريق تحرير ثوابت ملفات الملف C:Program Files (x86)ArduinolibrariesSharersrcSharerConfig.h .
// maximum number of shared functions
# define _SHARER_MAX_FUNCTION_COUNT 16
// maximum number of shared variables
# define _SHARER_MAX_VARIABLE_COUNT 32
// circle buffer size for user serial message
# define _SHARER_USER_RECEIVE_BUFFER_SIZE 64
// maximum number of call to Serial.read() each time Sharer.Run() is called
# define _SHARER_MAX_BYTE_READ_PER_RUN 1000 يمكنك العثور هنا على الوثائق الكاملة لـ Sharer.net: /sharer.net/sharer.net.documentation.md.
يأخذ الأمر أقل من 10 مللي ثانية ليتم استدعاؤه على Arduino UNO (Command + Response) في Bauds 115200. تم تحسين البروتوكول حتى لا يكون لديك سلاسل لفك التشفير ، مجرد دفق ثنائي للترحيل ، بايت بايت. تم تحسين بصمة الذاكرة باستخدام الماكرو F () و progmem لتخزين أسماء المتغير والوظيفة والوسائط في الفلاش.
يستخدم Sharer بروتوكول فريد يسمى Protocole Sharer. كل الأوامر التسلسلية التي تلقاها Arduino هي مفصلية.
أن أستمر ، أعدك ...
لدي بعض الأفكار لتوسيع ميزات المشاركة مثل:
إذا كنت مهتمًا بمساعدتي في تطوير المشاركة ، فسوف يسعدني تلقي طلبات الميزات. شوكة موضع ترحيب أيضًا ؛)
