From b357bfa7dddb45e8a692ad9391549466e3c05726 Mon Sep 17 00:00:00 2001 From: Romain Bazile Date: Fri, 3 Sep 2021 15:53:16 +0200 Subject: [PATCH] documentation update --- docs/expert_setup.md | 24 +++++++++++++++--------- docs/hat_hardware.md | 16 +++++++++------- docs/mqtt_messages.md | 15 ++++++++++++--- 3 files changed, 36 insertions(+), 19 deletions(-) diff --git a/docs/expert_setup.md b/docs/expert_setup.md index 4724aae..9afc149 100644 --- a/docs/expert_setup.md +++ b/docs/expert_setup.md @@ -291,9 +291,9 @@ Also change the `DEVICES` line to add the device we are going to use `/dev/seria DEVICES="/dev/serial0" ``` -Finally, we want to add the parameter `-n` to `GPSD_OPTIONS`: +Finally, we want to add the parameter `-n -r` to `GPSD_OPTIONS`: ```sh -GPSD_OPTIONS="-n" +GPSD_OPTIONS="-n -r" ``` Save your work, and restart gpsd by running the following: @@ -390,19 +390,25 @@ We need to edit the configuration of chrony, to activate both the GPS time synch Edit the file `/etc/chrony/chrony.conf` and replace its content with the following: ``` -server 0.pool.ntp.org maxpoll 5 -server 1.pool.ntp.org maxpoll 5 -server 2.pool.ntp.org maxpoll 5 -server 3.pool.ntp.org maxpoll 5 +pool pool.ntp.org iburst maxsources 4 driftfile /var/lib/chrony/drift -allow - +# allow to make big changes to clock if difference with ref clock is more than 1 seconds makestep 1 5 -refclock SHM 2 pps refid NMEA +refclock SHM 0 refid NMEA offset 0.006 +refclock SHM 1 pps refid NME+ +refclock SOCK /var/run/chrony.sock delay 0.0 refid SOCK +# noselect poll 8 filter 1000 #refclock PPS /dev/pps0 precision 1e-7 noselect refid GPPS + +allow all + +rtcsync + +logdir /var/log/chrony +log rtc refclocks ``` Before restarting `chrony`, we need to make sure the timesync service from systemd is deactivated: diff --git a/docs/hat_hardware.md b/docs/hat_hardware.md index 76b12a5..2d6ae92 100644 --- a/docs/hat_hardware.md +++ b/docs/hat_hardware.md @@ -10,6 +10,11 @@ Configured through a kernel driver. #### OLED Display Address 0x3c +#### LED control: LM36011 +Address 0x64 +Control through specific software, current range from 0 to 376mA in normal mode, up to 1.5A in flash mode. + + ### SPI0 Bus #### Motor Controller 0: TMC5160 Chip Enable: SPI0_CE0 @@ -32,14 +37,11 @@ GPIO20 for Stall output #### Fan control PWM1 control through GPIO13 -#### LED0 control -PWM dimming frequency range: 6.5 kHz to 100 kHz -PWM0 control through GPIO18 - -#### LED1 control -PWM dimming frequency range: 6.5 kHz to 100 kHz -PWM0 control through GPIO12 +#### LED Output selection +GPIO18: high for LED1, low for LED2 +#### LED Strobe +GPIO22 for pulse ### I2C0 Bus #### EEPROM M24C32 diff --git a/docs/mqtt_messages.md b/docs/mqtt_messages.md index bb46b64..f7cd415 100644 --- a/docs/mqtt_messages.md +++ b/docs/mqtt_messages.md @@ -84,12 +84,17 @@ This topic can also receive a config update message: } ``` -A camera settings message can also be received here. The fields `iso` and `shutter_speed` are optionals: +A camera settings message can also be received here. The fields `iso`, `shutter_speed`, `white_balance_gain`, `white_balance` and `image_gain` are optionals: ```json { "action": "settings", - "iso": 100, - "shutter_speed": 40 + "settings":{ + "iso": 100, + "shutter_speed": 40, + "white_balance_gain": {"red": 100, "blue": 100}, + "white_balance": "auto", + "image_gain": {"analog": 100, "digital": 100} + } } ``` @@ -112,9 +117,13 @@ This topic controls the segmentation process. The message is a JSON object: `action` can also be `stop`. The `action` element is the only element required. If no `path` is supplied, the whole images repository is segmented recursively (this is very long!). + `force` is going to overcome the presence of the file `done` that is here to prevent for resegmenting a folder already segmented. + `recursive` will force parsing all folders below `path`. + `ecotaxa` activates the export of an ecotaxa compatible archive. + `keep` allows to remove or keep the roi (when you do an ecotaxa export, no effects otherwise, the roi are kept). - Receive only