Sharer
v1.0.1
Sharer - это как , так и библиотека Arduino . Это позволяет настольному приложению считывать/записать переменные и функции удаленного вызова на Arduino , используя протокол Sharer, приобретающий последовательную связь. Средство Sharer была разработана для проекта BallCuber (https://ballcuber.github.io), но теперь это отдельная библиотека;).
// C#
var connection = new SharerConnection ( "COM3" , 115200 ) ;
connection . Connect ( ) ; Примечание: для некоторых досок, таких как микро и Леонардо, необходимо установить сигналы RTS и DTR с помощью RtsEnable и DtrEnable Properties.
// 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 ();
}Sharer разделен на 2 репозиторию, один для источников Arduino, а другой для источников .net
Sharer доступен в менеджере библиотеки, доступных в Tools/Manage Libraries... Просто ищите Sharer и установите последнюю версию.
Пожалуйста, загрузите архив библиотеки Sharer: https://github.com/rufus31415/sharer/releases/latest/download/sharer.zip
Шарер был протестирован с Arduino Uno, Nano, Mega и Due. Это может работать с другими досками. Извлеките так, чтобы вы получили каталог Sharer в своем каталоге Arduino "Libraries": C:Program Files (x86)ArduinolibrariesSharer
Затем вы можете насладиться примерами, перезапустив свой Arduino IDE и перейдите в File / examples / Sharer .
Sharer.net доступен на Nuget: https://www.nuget.org/packages/sharer/
Используйте эту командную строку, чтобы установить ее с помощью менеджера пакета:
Install-Package Sharer
Assembly Sharer.dll можно загрузить здесь: https://github.com/rufus31415/sharer.net/releases/latest/download/sharerasssemblies.zip
Этот архив содержит Nuget Package Sharer.nupkg и Sharer.dll, составленные в выпуске AnyCPU для следующих целей:
Пример форм Windows требует .NET Framework 3.5. Его можно загрузить здесь: https://github.com/rufus31415/sharer.net/releases/latest/download/sharerwindowsformsexample.zip
Пример консоли работает с .NET CORE 3.0. Но вам не нужно время выполнения, чтобы выполнить его. Здесь доступны отдельные примеры консоли:
© RUFUS31415 См. Файл лицензии для получения подробной информации.
Файл заголовка <sharer.h> должен быть включен.
В function setup() Sharer инициализируется путем передачи Baudrate toffication Sharer.init(...) . Он внутренне называет Serial.init() с тем же бодратом.
В функциональном loop() , Sharer.run() должен быть вызван. Он управляет внутренним ядром Sharer, который декодирует полученные команды.
# include < Sharer.h >
void setup () {
Sharer. init ( 115200 );
}
void loop () {
Sharer. run ();
}Вы также можете инициализировать Sharer с другим потоком, например, Serial2 Arduino, если вы используете Serial2 для связи с настольным приложением:
void setup () {
// Initialize with another Serial interface
Serial2. begin ( 9600 );
Sharer. init (Serial2);
} Чтобы добавить переменную в список общих переменных, вам следует позвонить в Macro Sharer_ShareVariable . Его первый аргумент - тип переменной, а второй - ее название. Этот макрос позволяет Sharer иметь указатель на переменную, ее название, его тип и ее размер памяти.
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. Первым аргументом является его имя, за которым следует тип и имя каждого аргумента.
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 наследует от потока, поэтому вы можете использовать следующие функции. Пожалуйста, никогда не используйте Sharer.print (), Sharer.println () или Sharer.write () внутри общей функции, написав Woud.
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 );
} Вы можете изменить пределы Sharer, редактируя константы файла 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) в 115200 бод. Протокол оптимизирован, чтобы не иметь строк для декодирования, просто двоичный поток для интерпретации, байт по байту. Следы памяти были оптимизированы с использованием макроса F () и ProGMEM для хранения имен переменной, функции и аргументов во Flash.
Sharer использует уникальный протокол, называемый протоколом Sharer. Каждое последовательные команды, полученные Arduino, пересекаются.
Продолжение, я обещаю ...
У меня есть некоторые идеи, чтобы расширить такие функции, как:
Если вы заинтересованы в помощи мне в разработке Sharer, я буду рад получить запросы на функции. Вилка также приветствуется;)
