Skip to content

Commit bebaf45

Browse files
TheUsernameOrSmthTheUsernameOrSmth
committed
Move fixture info under lmixer siderbar instead of DMX.
1 parent 1ef2b72 commit bebaf45

File tree

4 files changed

+39
-39
lines changed

4 files changed

+39
-39
lines changed

‎src/.vuepress/config.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,6 @@ export default defineUserConfig({
158158
collapsible: false,
159159
children: [
160160
'/lights/dmx/',
161-
'/lights/dmx/kistan_fixture_types',
162-
'/lights/dmx/kistan_lmixer_fixtures',
163-
'/lights/dmx/fixture_config',
164161
]
165162
}
166163
],
@@ -209,8 +206,11 @@ export default defineUserConfig({
209206
text: 'Reference',
210207
collapsible: true,
211208
children: [
212-
'/lights/lmixer/layers',
209+
'/lights/lmixer/layers',
213210
'/lights/lmixer/macros',
211+
'/lights/lmixer/reference/kistan_fixture_types',
212+
'/lights/lmixer/reference/kistan_lmixer_fixtures',
213+
'/lights/lmixer/reference/fixture_config',
214214
]
215215
},
216216

src/lights/dmx/fixture_config.md renamed to src/lights/lmixer/reference/fixture_config.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Fixture Config File
22

3-
All fixtures accessable in LMixer should also be in a config file, located [here](../../data/gen/kistanFixtures.json?url).
3+
All fixtures accessible in LMixer should also be in a config file, located [here](../../data/gen/kistanFixtures.json?url).
44

55
:::note
66
Currently, the nearly all of the fixtures on the master layer are listed here, other layers are not listed.
@@ -19,7 +19,7 @@ Whenever "Lua name" is mentioned, it refers to the variable name within LMixer
1919

2020
For the full schema, see [the schema](#schema)
2121

22-
The configuration file is a standard .json file, to allow maximum interopability.
22+
The configuration file is a standard .json file, to allow maximum interoperability.
2323

2424
The file needs a `formatVersion` which specifies the version, this should be incremented for breaking changes to the schema.
2525

@@ -32,21 +32,21 @@ The file needs a `formatVersion` which specifies the version, this should be inc
3232

3333
### ID Naming
3434

35-
IDs should always follow snake_case. Capital letters are allowed in names and abreviations.
35+
IDs should always follow snake_case. Capital letters are allowed in names and abbreviations.
3636

37-
When including the model name, the format is `[role/category (wash, wallspot, etc)]_[model name (abreviations AOK)]`
37+
When including the model name, the format is `[role/category (wash, wallspot, etc)]_[model name (abbreviations AOK)]`
3838

3939
## FixtureTypeSchema
4040

4141
Since multiple fixtures can behave the same way, FixtureType describes how a fixture maps it's channels to functions.
4242

43-
| key | type | comment |
44-
| ----------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
45-
| displayName | string | Human readable version of the name |
46-
| displayNamePlural | string? | For non-standard plural forms of words (Shelf->Shelves), if empty, "s" is appended to the display name |
47-
| model | string? | If the fixtureType is for a specific model |
48-
| description | string? | Optional extra information |
49-
| channels | Record<string, [FixtureChannelSchema](fixturechannelschema)> | A dictonary for what each channel maps to, the key should be the index of the dmx-channel ("1", "2", "3"). Make sure that it is 1-indexed |
43+
| key | type | comment |
44+
| ----------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
45+
| displayName | string | Human readable version of the name |
46+
| displayNamePlural | string? | For non-standard plural forms of words (Shelf->Shelves), if empty, "s" is appended to the display name |
47+
| model | string? | If the fixtureType is for a specific model |
48+
| description | string? | Optional extra information |
49+
| channels | Record<string, [FixtureChannelSchema](fixturechannelschema)> | A dictionary for what each channel maps to, the key should be the index of the dmx-channel ("1", "2", "3"). Make sure that it is 1-indexed |
5050

5151
### FixtureChannelSchema
5252

@@ -85,7 +85,7 @@ The `prog_` prefix (short for program\_), is used for preprogrammed functions, s
8585

8686
### RangeMappingSchema
8787

88-
Maps the 0-255 range onto another range when displaying. Most notable use case is rotations, were mapping from [0-255] to [0 degrees, 540 degrees] makes it more intutive to control.
88+
Maps the 0-255 range onto another range when displaying. Most notable use case is rotations, were mapping from [0-255] to [0 degrees, 540 degrees] makes it more intuitive to control.
8989

9090
| key | type | comment |
9191
| --- | ------ | ----------------------- |
@@ -98,14 +98,14 @@ Some channels are decimated into smaller chunks, for instance a relay might use
9898
Strobing speed for lights tend to have a deadzone, for both of these, a "ranged" function is suitable.
9999
(in this case ranged means divided into ranges)
100100

101-
| key | type | comment |
102-
| ------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------ |
103-
| min | number | The lower bound [inclusive] of the range |
104-
| max | number | The upper bound [inclusive] of the range |
105-
| functionID | string | Identifies what this range segment does, see [Range Naming](#range-naming) for naming guidelines |
106-
| displayName | string | Human readable name |
107-
| identialWithinRange | boolean? | Set to `true` if all the values in the range behave identically |
108-
| mapRangeForDisplay | [RangeMappingSchema](#rangemappingschema)? | Used for displaying values to the user, maps the [0, 255] range to something else. |
101+
| key | type | comment |
102+
| -------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------ |
103+
| min | number | The lower bound [inclusive] of the range |
104+
| max | number | The upper bound [inclusive] of the range |
105+
| functionID | string | Identifies what this range segment does, see [Range Naming](#range-naming) for naming guidelines |
106+
| displayName | string | Human readable name |
107+
| identicalWithinRange | boolean? | Set to `true` if all the values in the range behave identically |
108+
| mapRangeForDisplay | [RangeMappingSchema](#rangemappingschema)? | Used for displaying values to the user, maps the [0, 255] range to something else. |
109109

110110
:::note
111111
The ranges should not overlap. Overlapping ranges in undefined behavior.
@@ -131,26 +131,26 @@ When a channel is a lower nibble, simply append `_lower` to the name.
131131

132132
Since it is common for multiple fixture instance of the same type and model to exist, creation is grouped to allow for multiple at once. If only one is desired, only specify one channel.
133133

134-
| key | type | comment |
135-
| ----------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
136-
| type | string | The ID of the [Fixture Type](#fixturetypeschema) to use as the base |
137-
| displayName | string? | Human readable name of the group |
138-
| displayNamePlural | string? | Plural form of the name, if null, plural form is obtained by appending "s" to the singular version |
139-
| model | string? | The model of these fixtures. There is also a model field in the [Fixture Type Schema](#fixturetypeschema), the reason is that fixtures might use the same [Fixture Type](#fixturetypeschema) (e.g. A white LED strip and a white spotlight might both use the same brightness fixture type due to only having one channel) |
140-
| description | string? | Optional extra information |
141-
| fixtureChannels | Record<string, number> | The Lua names and channel ids for the fixtures. Each entry has it's key as the Lua name and the value as the first channel for the fixture (if the fixture has channels 10-16, then channel 10 should be specified)
134+
| key | type | comment |
135+
| ----------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
136+
| type | string | The ID of the [Fixture Type](#fixturetypeschema) to use as the base |
137+
| displayName | string? | Human readable name of the group |
138+
| displayNamePlural | string? | Plural form of the name, if null, plural form is obtained by appending "s" to the singular version |
139+
| model | string? | The model of these fixtures. There is also a model field in the [Fixture Type Schema](#fixturetypeschema), the reason is that fixtures might use the same [Fixture Type](#fixturetypeschema) (e.g. A white LED strip and a white spotlight might both use the same brightness fixture type due to only having one channel) |
140+
| description | string? | Optional extra information |
141+
| fixtureChannels | Record<string, number> | The Lua names and channel ids for the fixtures. Each entry has it's key as the Lua name and the value as the first channel for the fixture (if the fixture has channels 10-16, then channel 10 should be specified) |
142142

143143
## FixtureGroupSchema
144144

145145
In LMixer, fixtures can be grouped, so the config file also has support for this.
146146

147-
| key | type | comment |
148-
| --- | --- | --- |
149-
| description | string? | Optional extra information about the group |
150-
| fixtures | string[] | An array of the fixtures contained. The values are the Lua names of the fixtures. Fixture groups are also allowed to be specified with their Lua name |
147+
| key | type | comment |
148+
| ----------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
149+
| description | string? | Optional extra information about the group |
150+
| fixtures | string[] | An array of the fixtures contained. The values are the Lua names of the fixtures. Fixture groups are also allowed to be specified with their Lua name |
151151

152152
:::note
153-
Take care to order the FixtureGroups such that dependecies (other fixture groups) are ***earlier*** in the file then the dependent group. This is to simply the loading.
153+
Take care to order the FixtureGroups such that dependencies (other fixture groups) are **_earlier_** in the file then the dependent group. This is to simply the loading.
154154
:::
155155

156156
## Schema
@@ -186,7 +186,7 @@ export type FixtureTypeSchema = {
186186
displayName: string;
187187

188188
// The plural form of the displayName, if left blank, the plural
189-
// form is obtained by appendning "s". Useful of "shelf"->"shelves"
189+
// form is obtained by appending "s". Useful of "shelf"->"shelves"
190190
displayNamePlural?: string;
191191

192192
// The model/product name of the fixture
@@ -294,7 +294,7 @@ export type FixtureSchema = {
294294
// A group of fixtures
295295
export type FixtureGroupSchema = {
296296
// Array of the fixtures/group. The value is the Lua name,
297-
// which is why both fixture groups aswell as fixtures
297+
// which is why both fixture groups as well as fixtures
298298
// can be used
299299
fixtures: string[];
300300

src/lights/dmx/kistan_fixture_types.md renamed to src/lights/lmixer/reference/kistan_fixture_types.md

File renamed without changes.

src/lights/dmx/kistan_lmixer_fixtures.md renamed to src/lights/lmixer/reference/kistan_lmixer_fixtures.md

File renamed without changes.

0 commit comments

Comments
 (0)