searchindex.js

Search.setIndex({docnames:["backend_api_docs","endpoints_api","groundstation","groundstation_modules","groundstation_tests","index","modules_api"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["backend_api_docs.rst","endpoints_api.rst","groundstation.rst","groundstation_modules.rst","groundstation_tests.rst","index.rst","modules_api.rst"],objects:{"":{automation:[6,0,0,"-"],gs_commands:[6,0,0,"-"],manage:[6,0,0,"-"]},"groundstation.backend_api":{auth:[1,0,0,"-"],communications:[1,0,0,"-"],flightschedule:[1,0,0,"-"],housekeeping:[1,0,0,"-"],models:[0,0,0,"-"],passover:[1,0,0,"-"],telecommand:[1,0,0,"-"],user:[1,0,0,"-"],utils:[0,0,0,"-"],validators:[0,0,0,"-"]},"groundstation.backend_api.auth":{AuthLogin:[1,2,1,""],AuthLogout:[1,2,1,""]},"groundstation.backend_api.auth.AuthLogin":{post:[1,3,1,""]},"groundstation.backend_api.communications":{Communication:[1,2,1,""],CommunicationList:[1,2,1,""]},"groundstation.backend_api.communications.Communication":{get:[1,3,1,""]},"groundstation.backend_api.communications.CommunicationList":{get:[1,3,1,""],post:[1,3,1,""]},"groundstation.backend_api.flightschedule":{FlightScheduleList:[1,2,1,""],Flightschedule:[1,2,1,""]},"groundstation.backend_api.flightschedule.FlightScheduleList":{get:[1,3,1,""],post:[1,3,1,""]},"groundstation.backend_api.flightschedule.Flightschedule":{"delete":[1,3,1,""],get:[1,3,1,""],patch:[1,3,1,""]},"groundstation.backend_api.housekeeping":{HousekeepingLog:[1,2,1,""],HousekeepingLogList:[1,2,1,""]},"groundstation.backend_api.housekeeping.HousekeepingLog":{get:[1,3,1,""]},"groundstation.backend_api.housekeeping.HousekeepingLogList":{get:[1,3,1,""],post:[1,3,1,""]},"groundstation.backend_api.models":{Communications:[0,2,1,""],FlightScheduleCommands:[0,2,1,""],FlightScheduleCommandsArgs:[0,2,1,""],FlightSchedules:[0,2,1,""],Housekeeping:[0,2,1,""],Passover:[0,2,1,""],PowerChannels:[0,2,1,""],Telecommands:[0,2,1,""],User:[0,2,1,""]},"groundstation.backend_api.models.Communications":{to_json:[0,3,1,""]},"groundstation.backend_api.models.FlightScheduleCommands":{to_json:[0,3,1,""]},"groundstation.backend_api.models.FlightScheduleCommandsArgs":{to_json:[0,3,1,""]},"groundstation.backend_api.models.FlightSchedules":{to_json:[0,3,1,""]},"groundstation.backend_api.models.Housekeeping":{to_json:[0,3,1,""]},"groundstation.backend_api.models.Passover":{to_json:[0,3,1,""]},"groundstation.backend_api.models.PowerChannels":{to_json:[0,3,1,""]},"groundstation.backend_api.models.Telecommands":{to_json:[0,3,1,""]},"groundstation.backend_api.models.User":{decode_auth_token:[0,3,1,""],encode_auth_token_by_id:[0,3,1,""],to_json:[0,3,1,""],verify_password:[0,3,1,""]},"groundstation.backend_api.passover":{PassoverList:[1,2,1,""]},"groundstation.backend_api.passover.PassoverList":{get:[1,3,1,""],post:[1,3,1,""]},"groundstation.backend_api.telecommand":{Telecommand:[1,2,1,""],TelecommandList:[1,2,1,""]},"groundstation.backend_api.telecommand.Telecommand":{get:[1,3,1,""]},"groundstation.backend_api.telecommand.TelecommandList":{get:[1,3,1,""],post:[1,3,1,""]},"groundstation.backend_api.user":{UserEntity:[1,2,1,""],UserList:[1,2,1,""]},"groundstation.backend_api.user.UserEntity":{get:[1,3,1,""]},"groundstation.backend_api.user.UserList":{post:[1,3,1,""]},"groundstation.backend_api.utils":{add_arg_to_flightschedulecommand:[0,1,1,""],add_command_to_flightschedule:[0,1,1,""],add_flight_schedule:[0,1,1,""],add_message_to_communications:[0,1,1,""],add_passover:[0,1,1,""],add_telecommand:[0,1,1,""],add_user:[0,1,1,""],create_context:[0,1,1,""],dynamic_filters_communications:[0,1,1,""],dynamic_filters_housekeeping:[0,1,1,""],login_required:[0,1,1,""]},"groundstation.backend_api.validators":{ArgumentValidator:[0,2,1,""],AuthLoginValidator:[0,2,1,""],CommandValidator:[0,2,1,""],FlightScheduleCommandValidator:[0,2,1,""],FlightSchedulePatchCommandValidator:[0,2,1,""],FlightSchedulePatchValidator:[0,2,1,""],FlightScheduleValidator:[0,2,1,""],HousekeepingValidator:[0,2,1,""],PassoverListValidator:[0,2,1,""],PassoverValidator:[0,2,1,""],PowerChannelValidator:[0,2,1,""],TelecommandListValidator:[0,2,1,""],UserValidator:[0,2,1,""]},"groundstation.config":{BaseConfig:[3,2,1,""],DevelopmentConfig:[3,2,1,""],ProductionConfig:[3,2,1,""],TestingConfig:[3,2,1,""]},"groundstation.tests":{test_api:[4,0,0,"-"],test_auth:[4,0,0,"-"],test_backend_utils:[4,0,0,"-"],test_config:[4,0,0,"-"],test_models:[4,0,0,"-"],test_sat_sim:[4,0,0,"-"],utils:[4,0,0,"-"]},"groundstation.tests.test_api":{TestCommunicationsService:[4,2,1,""],TestFlightScheduleService:[4,2,1,""],TestHousekeepingService:[4,2,1,""],TestPassoverService:[4,2,1,""],TestTelecommandList:[4,2,1,""],TestTelecommandService:[4,2,1,""],TestUserService:[4,2,1,""]},"groundstation.tests.test_api.TestCommunicationsService":{test_get_communication_with_max_id_empty_db:[4,3,1,""]},"groundstation.tests.test_api.TestHousekeepingService":{test_get_all_housekeeping:[4,3,1,""],test_get_all_housekeeping_order_by_date:[4,3,1,""],test_get_housekeeping:[4,3,1,""],test_post_housekeeping_locally:[4,3,1,""],test_post_housekeeping_with_invalid_timestamp:[4,3,1,""],test_post_housekeeping_with_no_timestamp:[4,3,1,""]},"groundstation.tests.test_auth":{TestAuthentication:[4,2,1,""]},"groundstation.tests.test_auth.TestAuthentication":{setUp:[4,3,1,""]},"groundstation.tests.test_backend_utils":{TestUtils:[4,2,1,""]},"groundstation.tests.test_config":{TestTestingConfig:[4,2,1,""]},"groundstation.tests.test_models":{TestCommandModel:[4,2,1,""],TestFlightScheduleCommandsArgsModel:[4,2,1,""],TestFlightScheduleCommandsModel:[4,2,1,""],TestFlightScheduleModel:[4,2,1,""],TestHousekeepingModel:[4,2,1,""],TestUserModel:[4,2,1,""]},"groundstation.tests.test_sat_sim":{TestSatelliteSimulator:[4,2,1,""]},"groundstation.tests.utils":{fake_passover_as_dict:[4,1,1,""]},automation:{automate_communication:[6,1,1,""],automate_passovers:[6,1,1,""],main:[6,1,1,""]},groundstation:{config:[3,0,0,"-"],views:[3,0,0,"-"]},gs_commands:{GsCommands:[6,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"case":0,"class":[0,1,3,4,6],"default":6,"function":[2,5,6],"int":[0,1],"new":[0,1],"return":[0,1,4,6],"static":0,"true":0,The:[1,2,4,5,6],These:1,With:6,access:[0,3],add:0,add_arg_to_flightschedulecommand:0,add_command_to_flightschedul:0,add_flight_schedul:0,add_message_to_commun:0,add_passov:0,add_telecommand:0,add_us:0,adding:4,addit:6,additon:6,again:6,alchemi:0,all:[1,4],allow:[0,1,3,6],along:6,also:[1,6],ani:0,api:[1,2,5],app:[0,1,2,5],applic:[0,3,4,6],arg:0,argument:[0,4],argumentvalid:0,attribut:0,auth:[0,1],auth_token:0,authent:[0,2,5],authlogin:1,authloginvalid:0,authlogout:1,author:0,autom:[1,5],automat:6,automate_commun:6,automate_passov:6,backend:[2,5],backend_api:[0,1],base:3,baseconfig:3,beacon:4,becaus:0,befor:[4,6],behaviour:6,behind:0,below:6,best:1,bit:6,bodi:1,bool:0,branch:4,bug:4,build:0,call:[0,1,6],callabl:1,can:[0,3,6],channel:0,check:0,client:1,comm:[1,5],command:[0,4,6],command_id:0,command_line_command:6,command_nam:0,commandvalid:0,commun:[0,4],communicationlist:1,config:[2,5],configur:[2,3,5],contain:[0,4,6],content:5,context:0,creat:[0,1,3,4],create_context:0,creation_d:0,current:[1,4],current_in:0,data:[2,5],databas:[0,4],datastructur:0,date:4,datetim:4,decod:0,decode_auth_token:0,decor:[0,1,6],defin:[3,6],delet:1,develop:3,developmentconfig:3,dict:[0,1,4,6],dictionari:[0,4],differ:[3,4],dump_onli:0,dure:6,dynam:[0,4],dynamic_filters_commun:0,dynamic_filters_housekeep:0,each:6,edit:0,els:0,encode_auth_token_by_id:0,endpoint:[0,2,5],ensur:4,enter:6,entri:4,environ:3,essenti:[1,6],exampl:[0,6],exclud:0,execut:6,execution_tim:0,exercis:4,exist:[0,4],expect:0,expos:[1,4],extern:1,fake_passover_as_dict:4,fals:0,field:0,file:6,filter:[0,4],fix:4,fixtur:4,flask:[0,1,6],flighschedul:0,flight:[0,4],flightschedul:0,flightschedule_command_id:0,flightschedule_id:[0,1],flightschedulecommand:0,flightschedulecommandsarg:0,flightschedulecommandvalid:0,flightschedulelist:1,flightschedulepatchcommandvalid:0,flightschedulepatchvalid:0,flightschedulevalid:0,folder:4,follow:0,format:0,from:[0,3,6],fuction:6,gener:0,get:[1,4],govern:1,groundstat:[0,1],gs_command:5,gscommand:6,handl:0,have:[0,4],hook:4,hotfix:4,housekeep:[0,4],housekeeping_id:1,housekeepinglog:1,housekeepingloglist:[0,1],housekeepingvalid:0,houskeep:0,how:6,http:[1,4],human:6,ignore_kei:0,includ:6,index:[0,5],inform:0,initi:0,interact:1,intern:1,interpret:6,is_admin:0,is_danger:0,its:1,json:0,json_str:1,just:1,kei:[0,6],kwarg:0,like:[0,6],line:6,list:[0,1,4],live:6,load_onli:0,local:[0,1,4],local_arg:1,local_data:1,log:[1,4],login:0,login_requir:[0,1],made:1,main:6,mainli:6,make:[0,1],manag:5,mani:0,messag:[0,1,6],message_id:1,method:4,methodnam:4,mimick:6,mock:4,model:[2,5],modul:[0,1,2,5],multi:0,multidict:0,must:[0,4],name:0,need:0,nest:0,never:1,newlin:6,next:6,none:[0,1,6],note:0,noth:6,num_argu:0,object:1,onli:[0,1],open:6,oper:[0,6],option:0,order:0,other:[2,5],outsid:1,over:[1,4],overload:0,own:6,page:[3,5],pair:0,param:1,paramat:0,paramet:[0,1,4],partial:0,pass:[0,6],passov:[0,4,6],passoverlist:1,passoverlistvalid:0,passovervalid:0,password:0,patch:[0,1],path:6,payload:0,place:1,portal:6,post:[0,1],power:0,powerchannel:0,powerchannelvalid:0,pre:[0,6],present:0,probabl:1,product:3,productionconfig:3,protect:0,python3:6,python:1,queri:[0,1],react:[1,3],read:6,receiv:[0,1,4],refer:[0,2,5],request:1,requir:0,response_object:1,rest:[0,2,5],run:6,runtest:4,satellit:[2,5,6],save:1,schedul:[0,4],script:6,search:5,select:0,send:[4,6],sender:0,sent:6,separ:6,sequenc:0,servic:4,session:0,set:[0,1,4,6],setup:4,shell:1,should:[1,4,6],simul:[2,5],sinc:[1,4],singl:[0,1],situat:3,sleep:6,some:0,specif:[1,3],specifi:6,sql:0,statu:0,status_cod:1,store:6,str:0,string:6,sure:0,tabl:[0,1],telecommand:0,telecommand_id:1,telecommandlist:1,telecommandlistvalid:0,termin:6,test:[2,5,6],test_api:[4,6],test_auth:4,test_backend_util:4,test_config:4,test_get_all_housekeep:4,test_get_all_housekeeping_order_by_d:4,test_get_communication_with_max_id_empty_db:4,test_get_housekeep:[4,6],test_model:4,test_post_housekeeping_loc:4,test_post_housekeeping_with_invalid_timestamp:4,test_post_housekeeping_with_no_timestamp:4,test_sat_sim:4,testauthent:4,testcommandmodel:4,testcommunicationsservic:4,testflightschedulecommandsargsmodel:4,testflightschedulecommandsmodel:4,testflightschedulemodel:4,testflightscheduleservic:4,testhousekeepingmodel:4,testhousekeepingservic:[4,6],testingconfig:3,testpassoverservic:4,testsatellitesimul:4,testtelecommandlist:4,testtelecommandservic:4,testtestingconfig:4,testusermodel:4,testuserservic:4,testutil:4,than:4,thei:0,them:4,thi:[0,1,3,4,6],thr:6,through:[1,6],timer:6,timestamp:[0,4],to_json:0,token:0,top:6,tupl:[1,4],txt:6,type:[0,1],union:0,unknown:0,upload_d:0,upload_f:6,use:4,used:[0,1,3],user:[0,6],user_id:[0,1],userent:1,userlist:1,usernam:0,uservalid:0,using:0,util:[1,2,5],valid:[1,2,4,5],valu:[0,6],verify_password:0,via:1,view:[2,5],virtual:1,wake:6,want:[0,1],warn:1,werkzeug:0,what:6,when:[0,1,6],where:0,which:[0,1,3,4,6],work:0,world:1,would:1,wrap:4,wrapper:0,you:[0,1,3,6],your:6},titles:["Backend API","RESTful endpoints Reference","groundstation","Other groundstation modules","Groundstation Tests","Welcome to the AlbertaSat Groundstation Documentation!","Module API reference"],titleterms:{"function":0,The:0,albertasat:5,api:[0,4,6],app:4,authent:[1,4],autom:6,backend:[0,4],comm:6,commun:1,config:3,configur:4,data:[0,4],document:5,endpoint:1,flightschedul:1,groundstat:[2,3,4,5],gs_command:6,housekeep:1,indic:5,manag:6,model:[0,4],modul:[3,6],other:3,passov:1,refer:[1,6],rest:1,satellit:4,simul:4,tabl:5,telecommand:1,test:4,user:1,util:[0,4],valid:0,view:3,welcom:5}})