compAIR/compLIB
compAIR/compLIB
Archived
4
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update documentation

Browse source
This commit is contained in:
Konstantin Lampalzer 2021-01-23 13:37:07 +01:00
parent f72550146d
commit a7f5dd13c4
No known key found for this signature in database
GPG key ID: 9A60A522835A2AD9
23 changed files with 541 additions and 189 deletions
Download patch file Download diff file Expand all files Collapse all files

2
searchindex.js
View file

@ -1 +1 @@
Search.setIndex({docnames:["index","lib/Api","lib/Battery","lib/Buzzer","lib/IRSensor","lib/Motor","lib/Servo","lib/Vision","other/usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","lib/Api.rst","lib/Battery.rst","lib/Buzzer.rst","lib/IRSensor.rst","lib/Motor.rst","lib/Servo.rst","lib/Vision.rst","other/usage.rst"],objects:{"compLib.Api":{DoubleElim:[1,0,1,""],Position:[1,0,1,""],Seeding:[1,0,1,""]},"compLib.Api.DoubleElim":{get_goal:[1,1,1,""],get_items:[1,1,1,""],get_opponent:[1,1,1,""],get_position:[1,1,1,""]},"compLib.Api.Seeding":{get_park:[1,1,1,""],pay_park:[1,1,1,""],simon_says:[1,1,1,""]},"compLib.Battery":{Battery:[2,0,1,""]},"compLib.Battery.Battery":{percent:[2,1,1,""]},"compLib.Buzzer":{Buzzer:[3,0,1,""]},"compLib.Buzzer.Buzzer":{set:[3,1,1,""]},"compLib.IRSensor":{IRSensor:[4,0,1,""]},"compLib.IRSensor.IRSensor":{bottom_left:[4,1,1,""],bottom_middle:[4,1,1,""],bottom_right:[4,1,1,""],top_left_percent:[4,1,1,""],top_right_percent:[4,1,1,""]},"compLib.Motor":{Motor:[5,0,1,""]},"compLib.Motor.Motor":{all_off:[5,1,1,""],power:[5,1,1,""]},"compLib.Servo":{Servo:[6,0,1,""]},"compLib.Servo.Servo":{set_position:[6,1,1,""],setup_position:[6,1,1,""]},"compLib.Vision":{__Streaming:[7,0,1,""]},"compLib.Vision.__Streaming":{get_frame:[7,1,1,""],publish_frame:[7,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"001":7,"100":[2,4,5],"2021":0,"9898":7,"class":[0,1,4,6,7],"import":[1,2,3,5,7,8],"int":[1,2,4,5,6],"return":[1,2,4,7],"static":[1,2,3,4,5,6],"true":[1,3,4],"while":7,BUT:7,For:7,NOT:7,The:7,Use:7,Used:[2,3],Using:0,__main__:8,__name__:8,__stream:7,access:4,after:1,all:[1,5],all_off:5,alwai:1,angl:6,api:0,automat:7,back:1,backward:8,batteri:0,becaus:7,beep:8,between:[1,2,4,5,6],bin:8,bit:7,bool:[1,3,4],bottom:4,bottom_left:4,bottom_middl:4,bottom_right:4,browser:7,buffer:7,buup:8,buzzer:0,call:0,cam:7,camera:7,can:[1,7],captur:7,channel:6,chessboard:0,color_bgr2grai:7,come:7,commun:1,complib:[0,1,2,3,4,5,6,7,8],connect:[5,6,7],control:[5,6],convert:7,coordin:1,corner:7,creat:7,criteria:7,current:1,cv2:7,cvtcolor:7,datastructur:1,def:8,degre:1,detect:[0,4],dictionari:1,differ:4,displai:7,document:[0,7],done:7,doubl:0,doubleelim:1,draw:7,drawchessboardcorn:7,drive:[0,1],dure:6,ein:8,elif:1,elimin:0,els:1,exampl:0,fail:1,fals:[1,3],field:1,find:7,findchessboardcorn:7,forward:8,frame:7,from:[1,2,3,5,7,8],game:1,get:[1,2,4,7],get_fram:7,get_goal:1,get_item:1,get_oppon:1,get_park:1,get_posit:1,goal:1,grab:7,grai:7,grayscal:7,hallo:8,handl:7,here:7,hold:1,hopefulli:1,how:7,http:7,ich:8,imag:7,infrar:0,instanc:7,interact:[2,3],interfac:7,internet:7,irsensor:4,item:1,lag:7,left:[4,5],like:[1,7],list:1,littl:7,look:[1,7],main:8,make:1,max:5,mayb:0,middl:4,might:7,modul:[0,1],motor:[0,1,8],move:1,need:7,newest:7,next:1,none:7,note:7,now:1,object:1,off:0,onto:7,opencv:0,oppon:1,output:7,own:7,pai:1,paramet:[3,5,6,7],park:1,parkingsapc:1,pay_park:1,percent:[2,5],percentag:[0,4,5],point:[1,7],port:[5,6,8],posit:[0,6,7],power:[5,8],print:[0,1,8],process:[6,7],provid:7,publish:7,publish_fram:7,rang:[5,8],raspberri:7,realtim:7,record:7,request:1,ret:7,right:[4,5],robot:[1,4,6,8],rotat:1,rtmp:7,run:7,sai:1,score:1,screenshot:7,second:7,seed:0,sensor:0,server:7,servo:0,set:[3,5,6],set_posit:6,setup:6,setup_posit:6,should:[1,7],show:7,signal:4,similar:1,simon:1,simon_sai:1,sleep:[3,8],some:[1,7],someth:1,specifi:5,speed:5,statu:4,straight:0,stream:0,success:1,take:7,term_criteria_ep:7,term_criteria_max_it:7,test:7,thi:[1,7],time:[1,3,8],top:[4,5],top_left_perc:4,top_right_perc:4,turn:[0,5],type:[1,2,4],usag:0,use:7,used:[0,1,5,6],using:[1,7],view:7,vision:0,wait:7,want:7,web:7,webserv:7,websit:7,whatev:7,when:7,which:[5,7],yet:1,you:7,your:7,your_raspi_ip:7,yourself:7,zone:1},titles:["Robo4you Competition Library","Api","Battery","Buzzer","Infrared Sensor","Motor","Servo","Vision","Usage"],titleterms:{"class":[2,3,5],Using:7,api:1,batteri:2,buzzer:3,call:1,chessboard:7,competit:0,content:0,detect:7,document:[2,3,5],doubl:1,drive:5,elimin:1,exampl:[1,2,3,5,7],infrar:4,librari:0,mayb:5,modul:7,motor:5,off:3,opencv:7,percentag:2,posit:1,print:2,robo4y:0,seed:1,sensor:4,servo:6,straight:5,stream:7,turn:3,usag:8,vision:7}})
Search.setIndex({docnames:["index","lib/Api","lib/Battery","lib/Buzzer","lib/IRSensor","lib/Logging","lib/Motor","lib/Servo","lib/Vision","other/usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","lib/Api.rst","lib/Battery.rst","lib/Buzzer.rst","lib/IRSensor.rst","lib/Logging.rst","lib/Motor.rst","lib/Servo.rst","lib/Vision.rst","other/usage.rst"],objects:{"compLib.Api":{DoubleElim:[1,0,1,""],Position:[1,0,1,""],Seeding:[1,0,1,""]},"compLib.Api.DoubleElim":{get_goal:[1,1,1,""],get_items:[1,1,1,""],get_opponent:[1,1,1,""],get_position:[1,1,1,""]},"compLib.Api.Seeding":{get_park:[1,1,1,""],pay_park:[1,1,1,""],simon_says:[1,1,1,""]},"compLib.Battery":{Battery:[2,0,1,""]},"compLib.Battery.Battery":{percent:[2,1,1,""]},"compLib.Buzzer":{Buzzer:[3,0,1,""]},"compLib.Buzzer.Buzzer":{set:[3,1,1,""]},"compLib.IRSensor":{IRSensor:[4,0,1,""]},"compLib.IRSensor.IRSensor":{bottom_left:[4,1,1,""],bottom_middle:[4,1,1,""],bottom_right:[4,1,1,""],top_left_percent:[4,1,1,""],top_right_percent:[4,1,1,""]},"compLib.LogstashLogging":{Logging:[5,0,1,""]},"compLib.LogstashLogging.Logging":{get_logger:[5,1,1,""],set_debug:[5,1,1,""]},"compLib.Motor":{Motor:[6,0,1,""]},"compLib.Motor.Motor":{all_off:[6,1,1,""],power:[6,1,1,""]},"compLib.Servo":{Servo:[7,0,1,""]},"compLib.Servo.Servo":{set_position:[7,1,1,""],setup_position:[7,1,1,""]},"compLib.Vision":{__Streaming:[8,0,1,""]},"compLib.Vision.__Streaming":{get_frame:[8,1,1,""],publish_frame:[8,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"001":8,"100":[2,4,6],"2021":0,"9898":8,"class":[0,1,4,7,8],"float":6,"import":[1,2,3,5,6,8,9],"int":[1,2,4,6,7],"return":[1,2,4,5,8],"static":[1,2,3,4,5,6,7],"true":[1,3,4],"while":8,BUT:8,For:8,NOT:8,The:8,Use:8,Used:[2,3],Using:0,__main__:9,__name__:9,__stream:8,access:4,after:1,all:[1,6],all_off:6,alwai:1,angl:7,api:0,automat:8,back:1,backward:9,batteri:0,becaus:8,beep:9,between:[1,2,4,6,7],bin:9,bit:8,bool:[1,3,4],bottom:4,bottom_left:4,bottom_middl:4,bottom_right:4,browser:8,buffer:8,buup:9,buzzer:0,call:0,cam:8,camera:8,can:[1,5,8],captur:8,channel:7,chessboard:0,color_bgr2grai:8,come:8,commun:[1,5],competit:5,complib:[0,1,2,3,4,5,6,7,8,9],connect:[6,7,8],control:[6,7],convert:8,coordin:1,corner:8,creat:8,criteria:8,current:1,cv2:8,cvtcolor:8,datastructur:1,debug:5,def:9,degre:1,detect:[0,4],dictionari:1,differ:4,displai:8,document:[0,8],done:8,doubl:0,doubleelim:1,draw:8,drawchessboardcorn:8,drive:[0,1],dure:7,ein:9,elif:1,elimin:0,els:1,exampl:0,fail:1,fals:[1,3],field:1,find:8,findchessboardcorn:8,forward:9,frame:8,from:[1,2,3,5,6,8,9],game:1,get:[1,2,4,5,8],get_fram:8,get_goal:1,get_item:1,get_logg:5,get_oppon:1,get_park:1,get_posit:1,goal:1,grab:8,grai:8,grayscal:8,hallo:9,handl:8,here:8,hold:1,hopefulli:1,how:8,http:8,ich:9,imag:8,indexerror:6,infrar:0,instanc:8,interact:[2,3],interfac:8,internet:8,irsensor:4,item:1,lag:8,left:[4,6],level:5,librari:5,like:[1,8],list:1,littl:8,log:0,logger:5,logstash:5,logstashlog:5,look:[1,8],main:9,make:1,manual:5,max:6,mayb:0,middl:4,might:8,modul:[0,1],motor:[0,1,9],move:1,need:8,newest:8,next:1,none:8,note:8,now:1,object:[1,5],off:0,onto:8,opencv:0,oppon:1,organ:5,output:8,own:8,pai:1,paramet:[3,6,7,8],park:1,parkingsapc:1,pay_park:1,percent:[2,6],percentag:[0,4,6],point:[1,8],port:[6,7,9],posit:[0,7,8],power:[6,9],print:[0,1,9],process:[7,8],provid:8,publish:8,publish_fram:8,python:5,rais:6,rang:[6,9],raspberri:8,realtim:8,record:8,request:1,ret:8,right:[4,6],robot:[1,4,7,9],rotat:1,rtmp:8,run:8,sai:1,score:1,screenshot:8,second:8,seed:0,sensor:0,server:8,servo:0,set:[3,6,7],set_debug:5,set_posit:7,setup:7,setup_posit:7,should:[1,5,8],show:8,signal:4,similar:1,simon:1,simon_sai:1,sleep:[3,9],some:[1,8],someth:1,specifi:6,speed:6,statu:4,straight:0,stream:0,success:1,take:8,term_criteria_ep:8,term_criteria_max_it:8,test:8,thi:[1,5,8],time:[1,3,9],top:[4,6],top_left_perc:4,top_right_perc:4,turn:[0,6],type:[1,2,4,5],usag:0,use:[5,8],used:[0,1,5,6,7],using:[1,8],view:8,vision:0,wait:8,want:8,web:8,webserv:8,websit:8,whatev:8,when:[5,8],which:[6,8],yet:1,you:8,your:8,your_raspi_ip:8,yourself:8,zone:1},titles:["Robo4you Competition Library","Api","Battery","Buzzer","Infrared Sensor","Logging","Motor","Servo","Vision","Usage"],titleterms:{"class":[2,3,5,6],Using:8,api:1,batteri:2,buzzer:3,call:1,chessboard:8,competit:0,content:0,detect:8,document:[2,3,5,6],doubl:1,drive:6,elimin:1,exampl:[1,2,3,5,6,8],infrar:4,librari:0,log:5,mayb:6,modul:8,motor:6,off:3,opencv:8,percentag:2,posit:1,print:2,robo4y:0,seed:1,sensor:4,servo:7,straight:6,stream:8,turn:[3,5],usag:9,vision:8}})