# Receiver commands

Commands to configure the receiver. Not used in MYTHEN.

- receiver [s] starts/stops the receiver to listen to detector packets. Options: [ `start`, `stop`]. `Returns` ``(string) status of receiver[ `idle`, `running`].

- r_online [i] sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory. `Returns` ``(int)

- r_checkonline Checks the receiver if it is online/offline mode. Only get! `Returns` (string) "All online" or "[list of offline hostnames] : Not online".

- framescaught gets the number of frames caught by receiver. Average of all for multi-detector command. Only get! `Returns` ``(int)

- resetframescaught [i] resets the number of frames caught to 0. i can be any number. Use this if using status start, instead of acquire (this command is included). Only put! `Returns` ``(int)

- frameindex [i] gets the current frame index of receiver. Average of all for multi-detector command. Only get! `Returns` ``(int)

- r_lock [i] locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks. `Returns` ``(int)

- r_lastclient gets the last client communicating with the receiver. Only get! `Returns` ``(int)

- r_readfreq [i] sets/gets the stream frequency of data from receiver to client. i > 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms). `Returns` ``(int)

- rx_fifodepth [i] sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss (loss due to packet processing time in Listener threads), not if limited by writing. `Returns` ``(int)