firmware  v0.1.2
Chromation Spectrometer Dev-Kit
test_UsbCmd.h
1 #ifndef _TEST_USBCMD_H
2 #define _TEST_USBCMD_H
3 
4 /* =====[ GetBridgeLED ]===== */
5 // ReadLedState() -> led_state
6 // returns OFF, GREEN, or RED
7 void ReadLedState_returns_OFF_if_LED_is_off(void);
8 void ReadLedState_returns_GREEN_if_LED_is_on_and_green(void);
9 void ReadLedState_returns_RED_if_LED_is_on_and_red(void);
10 // GetBridgeLED()
11 void GetBridgeLED_waits_for_byte_led_num(void);
12 void GetBridgeLED_reads_byte_led_num(void);
13 void GetBridgeLED_writes_two_bytes_to_USB_host(void);
14 void GetBridgeLED_writes_OK_and_LED_STATE_if_led_num_is_valid(void);
15 void GetBridgeLED_writes_ERROR_and_pads_second_byte_if_led_num_is_invalid(void);
16 // SetBridgeLED()
17 void SetBridgeLED_waits_for_byte_led_num(void);
18 void SetBridgeLED_reads_byte_led_num(void);
19 void SetBridgeLED_waits_for_byte_led_setting(void);
20 void SetBridgeLED_reads_byte_led_setting(void);
21 void SetBridgeLED_applies_led_setting_and_writes_OK_if_parameters_are_valid(void);
22 void SetBridgeLED_writes_ERROR_if_led_num_is_invalid(void);
23 void SetBridgeLED_writes_ERROR_if_led_setting_is_invalid(void);
24 // GetSensorLED()
25 void GetSensorLED_waits_for_byte_led_num(void);
26 void GetSensorLED_reads_byte_led_num(void);
27 void GetSensorLED_sends_command_to_sensor(void);
28 void GetSensorLED_sends_led_num_to_sensor(void);
29 void GetSensorLED_writes_OK_to_indicate_it_sent_the_command_to_the_sensor(void);
30 void GetSensorLED_waits_for_sensor_to_signal_STATUS_data_ready(void);
31 void GetSensorLED_reads_status_from_sensor(void);
32 void GetSensorLED_waits_for_sensor_to_signal_LED_SETTING_data_ready(void);
33 void GetSensorLED_reads_led_setting_from_sensor(void);
34 void GetSensorLED_writes_sensor_status(void);
35 void GetSensorLED_writes_sensor_led_setting(void);
36 // SetSensorLED()
37 void SetSensorLED_waits_for_byte_led_num(void);
38 void SetSensorLED_reads_byte_led_num(void);
39 void SetSensorLED_waits_for_byte_led_setting(void);
40 void SetSensorLED_reads_byte_led_setting(void);
41 void SetSensorLED_sends_command_to_sensor(void);
42 void SetSensorLED_sends_led_num_to_sensor(void);
43 void SetSensorLED_sends_led_setting_to_sensor(void);
44 void SetSensorLED_writes_OK_to_indicate_it_sent_the_command_to_the_sensor(void);
45 void SetSensorLED_waits_for_sensor_to_signal_STATUS_data_ready(void);
46 void SetSensorLED_reads_status_from_sensor(void);
47 void SetSensorLED_writes_sensor_status(void);
48 // SetSensorConfig()
49 void SetSensorConfig_waits_for_byte_binning(void);
50 void SetSensorConfig_reads_byte_binning(void);
51 void SetSensorConfig_waits_for_byte_gain(void);
52 void SetSensorConfig_reads_byte_gain(void);
53 void SetSensorConfig_waits_for_byte_row_bitmap(void);
54 void SetSensorConfig_reads_byte_row_bitmap(void);
55 void SetSensorConfig_sends_command_to_sensor(void);
56 void SetSensorConfig_waits_for_sensor_to_signal_it_recognizes_the_command(void);
57 void SetSensorConfig_proceeds_with_sending_config_if_sensor_status_is_OK(void);
58 void SetSensorConfig_sends_binning_to_sensor(void);
59 void SetSensorConfig_sends_gain_to_sensor(void);
60 void SetSensorConfig_sends_row_bitmap_to_sensor(void);
61 void SetSensorConfig_waits_for_sensor_to_signal_STATUS_data_ready(void);
62 void SetSensorConfig_reads_status_from_sensor(void);
63 void SetSensorConfig_writes_OK_to_indicate_it_sent_the_command_to_the_sensor(void);
64 void SetSensorConfig_writes_sensor_status(void);
65 // GetSensorConfig()
66 void GetSensorConfig_sends_command_to_sensor(void);
67 void GetSensorConfig_writes_OK_to_indicate_it_sent_the_command_to_the_sensor(void);
68 void GetSensorConfig_waits_for_sensor_to_signal_STATUS_data_ready(void);
69 void GetSensorConfig_reads_status_from_sensor(void);
70 void GetSensorConfig_proceeds_reading_from_sensor_if_status_is_OK(void);
71 void GetSensorConfig_waits_for_sensor_to_signal_BINNING_data_ready(void);
72 void GetSensorConfig_reads_binning_from_sensor(void);
73 void GetSensorConfig_waits_for_sensor_to_signal_GAIN_data_ready(void);
74 void GetSensorConfig_reads_gain_from_sensor(void);
75 void GetSensorConfig_waits_for_sensor_to_signal_ROW_BITMAP_data_ready(void);
76 void GetSensorConfig_reads_row_bitmap_from_sensor(void);
77 void GetSensorConfig_writes_sensor_status(void);
78 void GetSensorConfig_writes_sensor_binning(void);
79 void GetSensorConfig_writes_sensor_gain(void);
80 void GetSensorConfig_writes_sensor_row_bitmap(void);
81 // GetExposure()
82 void GetExposure_sends_command_to_sensor(void);
83 void GetExposure_writes_OK_to_indicate_it_sent_the_command_to_the_sensor(void);
84 void GetExposure_waits_for_sensor_to_signal_STATUS_data_ready(void);
85 void GetExposure_reads_status_from_sensor(void);
86 void GetExposure_waits_for_sensor_to_signal_EXPOSURE_MSB_data_ready(void);
87 void GetExposure_reads_exposure_MSB_from_sensor(void);
88 void GetExposure_waits_for_sensor_to_signal_EXPOSURE_LSB_data_ready(void);
89 void GetExposure_reads_exposure_LSB_from_sensor(void);
90 void GetExposure_writes_sensor_status(void);
91 void GetExposure_writes_exposure_MSB(void);
92 void GetExposure_writes_exposure_LSB(void);
93 // SetExposure()
94 void SetExposure_waits_for_byte_exposure_MSB(void);
95 void SetExposure_reads_byte_exposure_MSB(void);
96 void SetExposure_waits_for_byte_exposure_LSB(void);
97 void SetExposure_reads_byte_exposure_LSB(void);
98 void SetExposure_sends_command_to_sensor(void);
99 void SetExposure_sends_exposure_MSB_to_sensor(void);
100 void SetExposure_sends_exposure_LSB_to_sensor(void);
101 void SetExposure_writes_OK_to_indicate_it_sent_the_command_to_the_sensor(void);
102 void SetExposure_waits_for_sensor_to_signal_STATUS_data_ready(void);
103 void SetExposure_reads_status_from_sensor(void);
104 void SetExposure_writes_sensor_status(void);
105 // CaptureFrame()
106 void CaptureFrame_sends_command_to_sensor(void);
107 void CaptureFrame_writes_OK_to_indicate_it_sent_the_command_to_the_sensor(void);
108 void CaptureFrame_waits_for_sensor_to_signal_STATUS_data_ready(void);
109 void CaptureFrame_reads_status_from_sensor(void);
110 void CaptureFrame_waits_for_sensor_to_signal_NUM_PIXELS_MSB_data_ready(void);
111 void CaptureFrame_reads_num_pixels_MSB_from_sensor(void);
112 void CaptureFrame_waits_for_sensor_to_signal_NUM_PIXELS_LSB_data_ready(void);
113 void CaptureFrame_reads_num_pixels_LSB_from_sensor(void);
114 void CaptureFrame_writes_sensor_status(void);
115 void CaptureFrame_writes_num_pixels_MSB(void);
116 void CaptureFrame_writes_num_pixels_LSB(void);
117 void CaptureFrame_returns_if_status_is_not_OK(void);
118 void CaptureFrame_waits_for_the_next_byte_of_frame_data(void);
119 void CaptureFrame_writes_the_next_byte_of_frame_data(void);
120 void CaptureFrame_loops_wait_for_byte_then_write_byte_for_a_total_nbytes_of_2x_num_pixels(void);
121 
122 #endif // _TEST_USBCMD_H
Generated by doxygen 1.9.1