deviationtx / deviation-manual Goto Github PK

The cover pages of the PDF manuals refer to the 4.0.1 version rather than 5.0 release. Also, the date on the covers is 2015 - needs to be fixed.

Substitutions don't get translated by sphinx (See sphinx-doc/sphinx#4293)

The graphic uses the word, "Effect" where the correct word should be "Affect". Two occurrences.

@F-D-R @PhracturedBlue can you please add a link to the Japanese HTML manual on deviationtx.com?

Description for this protocol is missing from the manuals.

Quoting the current wording:
"The SymaX protocol supports 7 channels and only supports auto-binding.
The eighth channel starts/stops video recording on each positive transition."

Do not consider this. Confusion between channel and mixer reorder

issue seems to be old version of pip in docker image...but I'm having trouble upgrading the docker users pip environment

I Propose the following changes for simpler formulas and a better understanding

Instead of
The combination of mixers for a given output channel is defined by the Mux type:

proposed
The combination Cx of mixers 1 to n for a given output channel is defined by the Mux type:

Change proposed for formulas and headings

The formula could take into account one multiply mux only for a better understanding. All muxes do not need to be multiply.
So the formula could refer to the [value resulting from mixers n-1 to 1] and the change by a multiply Mn.

So instead of

For a ‘Multiply’ mux:
Cx = if(\ |Sn|\ ) {\ |Mn|\ } else {1} * if (\ |Sn-1|\ ) {\ |Mn-1|\ } else {1} * … * if (\ |S0|\ ) {\ |M0|\ } else {1}

I propose

For a Mn ‘Multiply’ mux activated by switch Sn:
x = if(\ |Sn active|\ ) {\ |Mn|\ } else {1} * [value resulting from mixers n-1 to 1]

The same process could be used for every formula ( Replace, multply, add, Max and Min)

I have rewritten the deviation-manual history in order to remove all NOP commits from TravisCI as well as improve auto-commit descriptions.
The result is that we cut the total # of commits in half, and it is a lot easier to tell what changed when.
The downside is that it requires anyone with a clone to reclone from scratch

In the Complex mixer definitions the max value for scale is noted to 100% instead of 125 %
Text
Note that while the scale value is limited to 100%, the mixer may provide a value larger than 100% if an offset is set or if the trim value is non-zero.