Skip to content

Commit 992e0e1

Browse files
committed
Rename module to Chaotic Modulations and add README
1 parent ff14d15 commit 992e0e1

File tree

13 files changed

+38
-8
lines changed

13 files changed

+38
-8
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Custom units for the ER-301
2+
3+
Unless otherwise stated these units are for v0.6 firmware.
4+
5+
* [Chaotic Mods](./chaoticmods)
File renamed without changes.
File renamed without changes.

modulations/LogisticMap.lua renamed to chaoticmods/LogisticMap.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
local modulations = require "modulations.libmodulations"
1+
local chaos = require "chaoticmods.libchaoticmods"
22

33
local Class = require "Base.Class"
44
local GainBias = require "Unit.ViewControl.GainBias"
@@ -18,7 +18,7 @@ function LogisticMapUnit:onLoadGraph(channelCount)
1818
local clockComparator = self:addObject("clockComparator", app.Comparator())
1919
clockComparator:setTriggerMode()
2020

21-
local logisticMap = self:addObject("logisticMap", modulations.LogisticMap())
21+
local logisticMap = self:addObject("logisticMap", chaos.LogisticMap())
2222

2323
connect(clockComparator, "Out", logisticMap, "Trigger")
2424
connect(logisticMap, "Out", self, "Out1")
File renamed without changes.
File renamed without changes.

modulations/Lorenz.lua renamed to chaoticmods/Lorenz.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
local modulations = require "modulations.libmodulations"
1+
local chaos = require "chaoticmods.libchaoticmods"
22

33
local Class = require "Base.Class"
44
local Encoder = require "Encoder"
@@ -16,7 +16,7 @@ function Lorenz:init(args)
1616
end
1717

1818
function Lorenz:onLoadGraph(channelCount)
19-
local lorenz = self:addObject("lorenz", modulations.Lorenz())
19+
local lorenz = self:addObject("lorenz", chaos.Lorenz())
2020
local rate = self:addObject("rate", app.ParameterAdapter())
2121
local rho = self:addObject("rho", app.ParameterAdapter())
2222
local sigma = self:addObject("sigma", app.ParameterAdapter())

modulations/Makefile renamed to chaoticmods/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
# rather than auto-generated.
2222

2323
# Override these defaults on the commandline:
24-
PKGNAME ?= modulations
24+
PKGNAME ?= chaoticmods
2525
PKGVERSION ?= 0.0.1
26-
LIBNAME ?= libmodulations
26+
LIBNAME ?= libchaoticmods
2727
PROFILE ?= testing
2828
SDKPATH ?= ../er-301
2929

chaoticmods/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Chaotic Modulations
2+
3+
Basic chaotic modulation source units.
4+
5+
## Logistic Map
6+
7+
A clocked modulation source modelling the basic [logistic map](https://en.wikipedia.org/wiki/Logistic_map) equation.
8+
9+
<img src="./logisticmap.png">
10+
11+
Other than the clock input, there is a single parameter `r`. With `r` in the range `[3.56995, 4]` the sequence is chaotic for most values of `r`. Smaller values of `r` in that range exhibit more periods of (approximately) periodic behaviour, before sudden changes. With `r` Below 3.56995 the sequence will converge towards oscillating between 1, 2, 4 , 8, or 16 fixed values.
12+
13+
## Lorenz system
14+
15+
This is a continuous modulation source.
16+
17+
<img src="./lorenz.png">
18+
19+
The [Lorenz system](https://en.wikipedia.org/wiki/Lorenz_system) is defined by a set of three ordinary differential equations.
20+
21+
There other than the rate, there are three parameters in the differential equations that can be adjusted from their starting values of `ρ = 28`, `σ = 10`, and `β = 8/3`. Care must be taken: it's pretty easy to land on values where oscillation stops entirely.
22+
23+
There are three options for the output corresponding to the the variables in the system of differential equations: `x`, `y`, and `z`. For many parameters `x` and `y` will exhibit quite similar behaviour, but not always.
File renamed without changes.

0 commit comments

Comments
 (0)