altoslib: Document how to add a new product
[fw/altos] / altoslib / NewProduct
1 When adding a new product to the java code, there are a number of
2 places that might need adjustment:
3
4 altoslib/
5
6  1. AltosLib.java
7
8         Declare new log format
9         Declare new USB ids
10         Declare new Product name
11         Add item to product_name function
12
13  2. AltosIdleFetch.java
14
15         Declare any new sensors, create new sensor class
16         Create new sensor class for ADC values
17         Add new AltosIdler entry to idlers array
18
19  3. AltosEepromRecordSet.java
20
21         Map new log format to new log record decode class
22
23  4. AltosIMU.java
24
25         Map new imu_type (which includes orientation) correctly
26
27  5. AltosConfigData.java
28
29         Adjust invert_accel_value for new log format or product name
30         Adjust use_flash_for_config as needed
31         Adjust various accel_inverted functions
32         Adjust adxl375_axis
33
34  6. AltosTelemetry.java
35
36         Define new telemetry packet types
37
38
39  7. AltosTelemetryStandard.java
40
41         Map telemetry packet type to new decoder class
42
43  8. AltosTelemetry*.java
44
45         Adjust existing telemetry decoders for new sensors
46
47
48 altosuilib/
49
50  1. AltosUSBDevice.java
51
52         Add new product ID as appropriate to matchProduct