Robko JS - Reference Gude

Back to Robko JS demo

Robko - object

Описание
	Обект за връзка и управление на Robko JS

Properties
Robko.state
		Описание - Данни за стъстоянието на Robko
		
		Events - (unsigned 8 bit integer) събития
			READ-ONLY
			bit7 - има ли НОВИ събития
			bit6 - промяна в статуса на сервотата (виж ServoReady)
			bit5 - не се използва
			bit4 - не се използва
			bit3 - промяна в потенциометрите (виж Potentiometer)
			bit2 - double click (виж EventsDoubleClick)
			bit1 - отпуснат е бутон (виж EventsRelease)
			bit0 - натиснат е бутон (виж EventsPress)
			
		EventsPress - (unsigned 8 bit integer) бутон(и) който е натиснат
			READ-ONLY
			bit7 - не се използва
			bit6 - не се използва
			bit5 - натиснат е бутон 5
			bit4 - натиснат е бутон 4
			bit3 - натиснат е бутон 3
			bit2 - натиснат е бутон 2
			bit1 - натиснат е бутон 1
			bit0 - натиснат е бутон 0
			
		EventsRelease - (unsigned 8 bit integer) бутон(и) който е отпуснат
			READ-ONLY
			bit7 - не се използва
			bit6 - не се използва
			bit5 - отпуснат е бутон 5
			bit4 - отпуснат е бутон 4
			bit3 - отпуснат е бутон 3
			bit2 - отпуснат е бутон 2
			bit1 - отпуснат е бутон 1
			bit0 - отпуснат е бутон 0
			
		EventsDoubleClick - (unsigned 8 bit integer) бутон(и) double click
			READ-ONLY
			bit7 - не се използва
			bit6 - не се използва
			bit5 - double click бутон 5
			bit4 - double click бутон 4
			bit3 - double click бутон 3
			bit2 - double click бутон 2
			bit1 - double click бутон 1
			bit0 - double click бутон 0
			
		Potentiometer - (array of unsigned 10 bit integer)
			READ-ONLY
			6 values in range 0 - 1023
			
		ServoReady - (unsigned 8 bit integer) серво готово за нова команда (в покой)
			READ-ONLY
			bit7 - не се използва
			bit6 - не се използва
			bit5 - серво 5
			bit4 - серво 4
			bit3 - серво 3
			bit2 - серво 2
			bit1 - серво 1
			bit0 - серво 0
			
		Servo - (array of unsigned 10 bit integer)
			6 values in range 0 - 1023
			
		LimitSpeed - (unsigned 8 bit integer) скорост
			0 - най-бърза
			5 - най-бавна
			
		LimitLow - (array of unsigned 10 bit integer) долна граница
			6 values in range 0 - 1023
			
		LimitHigh - (array of unsigned 10 bit integer) горна граница
			6 values in range 0 - 1023

Methods
Robko.connect(host, user, password)
	Описание
		Свързване с Robko. При успешно изградена връзка се изпраща команда за отиване в "начална" 
		позиция. При всяка промяна в потенциометрите се изпраща команда към сервотата да я 
		изпълнят (виж Robko.enablePotentiometers и Robko.disablePotentiometers);
	
	Параметри
		host     - Хост
		user     - Потребител - стандартен потребител olimex
		password - Парола - стандартна парола olimex
	
	Резултат - няма
	
Robko.isConnected()
	Описание
		Проверка дали има активна връзка с Robko
	
	Параметри - няма
	
	Резултат
		true - връзката с Robko е активна
		false - връзката с Robko не е активна
		
Robko.get(callback)
	Описание
		Опресняване на данните от Robko
	
	Параметри 
		callback - функция, която да бъде изпълнена при успешно получаване на данните
	
	Резултат
		true - заявката е изпратена
		false - връзката с Robko не е активна
		
Robko.post(data, callback)
	Описание
		Изпращане на данни/команда към Robko
	
	Параметри 
		data - данни които да бъдат изпратени
		callback - функция, която да бъде изпълнена при успешно изпращане на данните
	
	Резултат
		true - заявката е изпратена
		false - връзката с Robko не е активна
		
Robko.gotoHome()
	Описание
		Изпраща команда за връщане в "начална" позиция
	
	Параметри - няма
	
	Резултат
		true - заявката е изпратена
		false - връзката с Robko не е активна
		
Robko.enablePotentiometers()
	Описание
		Разрешава използването на потенциометрите за задаване на позиция
	
	Параметри - няма
	
	Резултат - няма
	
Robko.disablePotentiometers()
	Описание
		Забранява използването на потенциометрите за задаване на позиция
	
	Параметри - няма
	
	Резултат - няма
	
Robko.setPotentiometers(value)
	Описание
		Забранява или разрешава използването на потенциометрите за задаване на позиция
	
	Параметри
		value 
			- true - разрешава
			- false - забранява
	
	Резултат - няма
	
Robko.scale(index, value)
	Описание
		Преобразува стойност от 0 до 1023 в позволените граници за съответния канал
	
	Параметри
		index - индекс на серво канала
		value - стойност 0 - 1023
	
	Резултат - преобразувана стойност
	
Robko.normalize(index, value)
	Описание
		Преобразува абсолютна стойност от позволените граници за съответния канал до стойност между 0 и 1023
	
	Параметри
		index - индекс на серво канала
		value - абсолютна стойност
	
	Резултат - нормализирана стойност
	
Robko.processPotentiometers(force)
	Описание
		Обработва състоянието на потенциометрите за задаване на позиция
	
	Параметри
		force 
			- true - изпраща заявка независимо дали има промяна в състоянието на потенциометрите
			- false - изпраща заявка само ако има промяна в състоянието на потенциометрите
	
	Резултат
		true - заявката е изпратена
		false - връзката с Robko не е активна или няма промяна в състоянието на потенциометрите
		
Robko.set(index, value)
	Описание
		Задава стойност на избрано серво
	
	Параметри 
		index - 0-5 серво 
		value - 0-1023 стойност. Ако стойноста е извън зададените граници се ограничава до тях
	
	Резултат
		true - заявката е изпратена
		false - връзката с Robko не е активна
		
Robko.step(index, value)
	Описание
		Задава стъпка в желана посоко на избрано серво
	
	Параметри 
		index - 0-5 серво 
		value - стойност. Може да е положителна или отрицателна
	
	Резултат
		true - заявката е изпратена
		false - връзката с Robko не е активна

Step - object

Описание
	Обект описващ стъпка от програма за Robko JS

Methods
	Step - constructor
	Описание
		Създава нова стъпка от текущата позиция на сервотата
	
	Параметри - няма
	
	Резултат - няма

Program - object

Описание
	Обект описващ програма за Robko JS
	
Methods
	Program.addStep(step)
	Описание
		Добавя нова стъпка към програмата
	
	Параметри
		step - Step обект, описващ състоянието на сервотата
		
	Резултат
		true - стъпката е добавена
		false - проблем при изпълнението
	
	Program.insertStep(position, step)
	Описание
		Вмъква нова стъпка на посочената позиция
	
	Параметри
		position - позиция, на която да бъде вмъкната новата стъпка
		step - Step обект, описващ състоянието на сервотата
		
	Резултат
		true - стъпката е вмъкната
		false - проблем при изпълнението
	
	Program.replaceStep(position, step)
	Описание
		Заменя стъпката на посочената позиция
	
	Параметри
		position - позиция на заменяната стъпка
		step - Step обект, описващ състоянието на сервотата
		
	Резултат
		true - стъпката е заменена
		false - проблем при изпълнението
	
	Program.removeStep(position)
	Описание
		Изтрива стъпката на посочената позиция
	
	Параметри
		position - позиция на изтриваната стъпка
		
	Резултат
		true - стъпката е изтрита
		false - проблем при изпълнението
	
	Program.stepsCount()
	Описание
		Брой съпки в програмата
	
	Параметри - няма
		
	Резултат - брой съпки в програмата
	
	Program.first()
	Описание
		Първа стъпка от програмата
	
	Параметри - няма
		
	Резултат - Step обект на първата стъпка от програмата или NULL ако няма зададена
	
	Program.next()
	Описание
		Следваща стъпка от програмата
	
	Параметри - няма
		
	Резултат - Step обект на следващата стъпка от програмата или NULL ако са свърщили
	
	Program.gotoStep(position)
	Описание
		Отива на посочената стъпка от програмата
	
	Параметри
		position - позиция на стъпката
		
	Резултат
		true - заявката е изпратена
		false - проблем при изпълнението
	Program.execute()
	Описание
		Изпълняване на програмата
	
	Параметри - няма
		
	Резултат
		true - заявката е изпратена
		false - проблем при изпълнението