Adding CHANGELOG entries #428
ryan-summersAnnotations
1 error and 20 warnings
|
style
Process completed with exit code 1.
|
|
useless conversion to the same type: `[output_channel::OutputChannel; 4]`:
src/main.rs#L74
warning: useless conversion to the same type: `[output_channel::OutputChannel; 4]`
--> src/main.rs:74:29
|
74 | output_channel: [Default::default(); 4].into(),
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider removing `.into()`: `[Default::default(); 4]`
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#useless_conversion
= note: `#[warn(clippy::useless_conversion)]` on by default
|
|
use of `default` to create a unit struct:
src/net/telemetry.rs#L52
warning: use of `default` to create a unit struct
--> src/net/telemetry.rs:52:50
|
52 | _telemetry: core::marker::PhantomData::default(),
| ^^^^^^^^^^^ help: remove this call to `default`
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#default_constructed_unit_structs
= note: `#[warn(clippy::default_constructed_unit_structs)]` on by default
|
|
this is an outer doc comment and does not apply to the parent module or crate:
src/net/telemetry.rs#L1
warning: this is an outer doc comment and does not apply to the parent module or crate
--> src/net/telemetry.rs:1:1
|
1 | / ///! Thermostat Telemetry Capabilities
2 | | ///!
3 | | ///! # Design
4 | | ///! Telemetry is reported regularly using an MQTT client. All telemetry is reported in SI units
... |
11 | | ///! required immediately before transmission. This ensures that any slower computation required
12 | | ///! for unit conversion can be off-loaded to lower priority tasks.
| |___________________________________________________________________^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
|
1 + //! Thermostat Telemetry Capabilities
2 + //!
3 + //! # Design
4 + //! Telemetry is reported regularly using an MQTT client. All telemetry is reported in SI units
5 + //! using standard JSON format.
6 + //!
7 + //! In order to report ADC/DAC codes generated during the DSP routines, a telemetry buffer is
8 + //! employed to track the latest codes. Converting these codes to SI units would result in
9 + //! repetitive and unnecessary calculations within the DSP routine, slowing it down and limiting
10 + //! sampling frequency. Instead, the raw codes are stored and the telemetry is generated as
11 + //! required immediately before transmission. This ensures that any slower computation required
12 + //! for unit conversion can be off-loaded to lower priority tasks.
|
|
|
this is an outer doc comment and does not apply to the parent module or crate:
src/net/network_processor.rs#L1
warning: this is an outer doc comment and does not apply to the parent module or crate
--> src/net/network_processor.rs:1:1
|
1 | / ///! Task to process network hardware.
2 | | ///!
3 | | ///! # Design
4 | | ///! The network processir is a small taks to regularly process incoming data over ethernet, handle
5 | | ///! the ethernet PHY state, and reset the network as appropriate.
| |__________________________________________________________________^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
|
1 + //! Task to process network hardware.
2 + //!
3 + //! # Design
4 + //! The network processir is a small taks to regularly process incoming data over ethernet, handle
5 + //! the ethernet PHY state, and reset the network as appropriate.
|
|
|
this is an outer doc comment and does not apply to the parent module or crate:
src/net/mod.rs#L1
warning: this is an outer doc comment and does not apply to the parent module or crate
--> src/net/mod.rs:1:1
|
1 | / ///! Stabilizer network management module
2 | | ///!
3 | | ///! # Design
4 | | ///! The stabilizer network architecture supports numerous layers to permit transmission of
5 | | ///! telemetry (via MQTT), configuration of run-time settings (via MQTT + Miniconf), and live data
6 | | ///! streaming over raw UDP/TCP sockets. This module encompasses the main processing routines
7 | | ///! related to Stabilizer networking operations.
| |_________________________________________________^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
|
1 + //! Stabilizer network management module
2 + //!
3 + //! # Design
4 + //! The stabilizer network architecture supports numerous layers to permit transmission of
5 + //! telemetry (via MQTT), configuration of run-time settings (via MQTT + Miniconf), and live data
6 + //! streaming over raw UDP/TCP sockets. This module encompasses the main processing routines
7 + //! related to Stabilizer networking operations.
|
|
|
this is an outer doc comment and does not apply to the parent module or crate:
src/hardware/system_timer.rs#L1
warning: this is an outer doc comment and does not apply to the parent module or crate
--> src/hardware/system_timer.rs:1:1
|
1 | / ///! System timer used for non-RTIC compatibility
2 | | ///!
3 | | ///! # Design
4 | | ///! `Clock` is implemented using the RTIC `app::monotonics::now()` default `Monotonic`.
5 | | ///! That `Monotonic` must tick at 1 kHz.
| |__________________________________________^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
|
1 + //! System timer used for non-RTIC compatibility
2 + //!
3 + //! # Design
4 + //! `Clock` is implemented using the RTIC `app::monotonics::now()` default `Monotonic`.
5 + //! That `Monotonic` must tick at 1 kHz.
|
|
|
this is an outer doc comment and does not apply to the parent module or crate:
src/hardware/pwm.rs#L1
warning: this is an outer doc comment and does not apply to the parent module or crate
--> src/hardware/pwm.rs:1:1
|
1 | / ///! Thermostat TEC driver IC voltage/current limits PWM driver.
2 | | ///!
3 | | ///! The Thermostat TEC driver ICs feature current limits controlled by an analog voltage input.
4 | | ///! This voltage is controlled by the MCU using low-pass filtered PWM outputs.
5 | | ///!
| |____^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
help: use an inner doc comment to document the parent module or crate
|
1 + //! Thermostat TEC driver IC voltage/current limits PWM driver.
2 + //!
3 + //! The Thermostat TEC driver ICs feature current limits controlled by an analog voltage input.
4 + //! This voltage is controlled by the MCU using low-pass filtered PWM outputs.
5 + //!
|
|
|
this is an outer doc comment and does not apply to the parent module or crate:
src/hardware/dac.rs#L1
warning: this is an outer doc comment and does not apply to the parent module or crate
--> src/hardware/dac.rs:1:1
|
1 | / ///! Thermostat DAC driver
2 | | ///!
3 | | ///! This file contains the driver for the 4 Thermostat DAC output channels.
4 | | ///! To convert a 18 bit word into an analog current Thermostat uses a DAC to
... |
11 | | ///! TEC driver datasheet: https://datasheets.maximintegrated.com/en/ds/MAX1968-MAX1969.pdf
12 | | ///!
| |____^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments
= note: `#[warn(clippy::suspicious_doc_comments)]` on by default
help: use an inner doc comment to document the parent module or crate
|
1 + //! Thermostat DAC driver
2 + //!
3 + //! This file contains the driver for the 4 Thermostat DAC output channels.
4 + //! To convert a 18 bit word into an analog current Thermostat uses a DAC to
5 + //! convert the word into a voltage and a subsequent TEC driver IC that produces
6 + //! a current proportional to the DAC voltage.
7 + //!
8 + //! The 4 channel DAC ICs share an SPI bus and are addressed using individual "sync"
9 + //! signals, similar to a chip select signal.
10 + //! DAC datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/AD5680.pdf
11 + //! TEC driver datasheet: https://datasheets.maximintegrated.com/en/ds/MAX1968-MAX1969.pdf
12 + //!
|
|
|
compile (stable)
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v2, actions-rs/toolchain@v1, actions-rs/cargo@v1. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.
|
|
compile (stable)
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2, actions-rs/toolchain@v1, actions-rs/cargo@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
|
|
compile (stable)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
|
compile (stable)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
|
compile (stable)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
|
compile (stable)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
|
style
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v2, actions-rs/toolchain@v1, actions-rs/cargo@v1, actions-rs/clippy-check@v1, actions/setup-python@v1. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.
|
|
style
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2, actions-rs/toolchain@v1, actions-rs/cargo@v1, actions-rs/clippy-check@v1, actions/setup-python@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
|
|
style
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
|
style
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
|
style
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
|
style
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|