Skip to content

Commit d19f01b

Browse files
authored
Renamed lightentity to light where applicable. (#184)
1 parent a809d75 commit d19f01b

16 files changed

Lines changed: 47 additions & 47 deletions

src/CodeCasa.AutomationPipelines.Lights/Cycle/CompositeLightTransitionCycleConfigurator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,9 @@ public ILightTransitionCycleConfigurator ForLights(IEnumerable<string> lightIds,
121121
return this;
122122
}
123123

124-
public ILightTransitionCycleConfigurator ForLights(IEnumerable<ILight> lightEntities, Action<ILightTransitionCycleConfigurator> configure, ExcludedLightBehaviours excludedLightBehaviour = ExcludedLightBehaviours.None)
124+
public ILightTransitionCycleConfigurator ForLights(IEnumerable<ILight> lights, Action<ILightTransitionCycleConfigurator> configure, ExcludedLightBehaviours excludedLightBehaviour = ExcludedLightBehaviours.None)
125125
{
126-
var lightIds = CompositeHelper.ResolveGroupsAndValidateLightsSupported(lightEntities, activeConfigurators.Keys);
126+
var lightIds = CompositeHelper.ResolveGroupsAndValidateLightsSupported(lights, activeConfigurators.Keys);
127127
return ForLights(lightIds, configure, excludedLightBehaviour);
128128
}
129129
}

src/CodeCasa.AutomationPipelines.Lights/Cycle/ILightTransitionCycleConfigurator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,10 @@ public interface ILightTransitionCycleConfigurator
133133
/// <summary>
134134
/// Creates a scoped cycle configuration for multiple light entities.
135135
/// </summary>
136-
/// <param name="lightEntities">The light entities to configure.</param>
136+
/// <param name="lights">The light entities to configure.</param>
137137
/// <param name="configure">An action to configure the cycle for these lights.</param>
138138
/// <param name="excludedLightBehaviour">Specifies the behavior for lights not included in this scoped configuration. Defaults to <see cref="ExcludedLightBehaviours.None"/>.</param>
139139
/// <returns>The configurator instance for method chaining.</returns>
140-
ILightTransitionCycleConfigurator ForLights(IEnumerable<ILight> lightEntities, Action<ILightTransitionCycleConfigurator> configure, ExcludedLightBehaviours excludedLightBehaviour = ExcludedLightBehaviours.None);
140+
ILightTransitionCycleConfigurator ForLights(IEnumerable<ILight> lights, Action<ILightTransitionCycleConfigurator> configure, ExcludedLightBehaviours excludedLightBehaviour = ExcludedLightBehaviours.None);
141141
}
142142
}

src/CodeCasa.AutomationPipelines.Lights/Cycle/LightTransitionCycleConfigurator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ public ILightTransitionCycleConfigurator ForLights(IEnumerable<string> lightIds,
9090
return this;
9191
}
9292

93-
public ILightTransitionCycleConfigurator ForLights(IEnumerable<ILight> lightEntities, Action<ILightTransitionCycleConfigurator> configure, ExcludedLightBehaviours excludedLightBehaviour = ExcludedLightBehaviours.None)
93+
public ILightTransitionCycleConfigurator ForLights(IEnumerable<ILight> lights, Action<ILightTransitionCycleConfigurator> configure, ExcludedLightBehaviours excludedLightBehaviour = ExcludedLightBehaviours.None)
9494
{
95-
CompositeHelper.ResolveGroupsAndValidateLightSupported(lightEntities, Light.Id);
95+
CompositeHelper.ResolveGroupsAndValidateLightSupported(lights, Light.Id);
9696
return this;
9797
}
9898
}

src/CodeCasa.AutomationPipelines.Lights/DimmerOptions.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@ public record DimmerOptions
2525
/// <summary>
2626
/// Gets or sets the collection of light IDs that define the order for dimming operations.
2727
/// </summary>
28-
public IEnumerable<string>? DimOrderLightEntities { get; set; }
28+
public IEnumerable<string>? DimOrderLights { get; set; }
2929

3030
/// <summary>
3131
/// Sets the light order for dimming operations based on the provided collection of light entities.
3232
/// </summary>
33-
/// <param name="lightEntities">The light entities that define the dimming order.</param>
34-
public void SetLightOrder(IEnumerable<ILight> lightEntities) =>
35-
DimOrderLightEntities = lightEntities.Select(l => l.Id).ToArray();
33+
/// <param name="lights">The light entities that define the dimming order.</param>
34+
public void SetLightOrder(IEnumerable<ILight> lights) =>
35+
DimOrderLights = lights.Select(l => l.Id).ToArray();
3636

3737
/// <summary>
3838
/// Sets the light order for dimming operations based on the provided light entities.
3939
/// </summary>
40-
/// <param name="lightEntities">The light entities that define the dimming order.</param>
41-
public void SetLightOrder(params ILight[] lightEntities) =>
42-
DimOrderLightEntities = lightEntities.Select(l => l.Id).ToArray();
40+
/// <param name="lights">The light entities that define the dimming order.</param>
41+
public void SetLightOrder(params ILight[] lights) =>
42+
DimOrderLights = lights.Select(l => l.Id).ToArray();
4343
}

src/CodeCasa.AutomationPipelines.Lights/Extensions/DimmerOptionsExtensions.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ internal static class DimmerOptionsExtensions
44
{
55
public static void ValidateSingleLight(this DimmerOptions dimmerOptions, string lightId)
66
{
7-
var dimOrderLightEntitiesArray = dimmerOptions.DimOrderLightEntities?.ToArray();
8-
if (dimOrderLightEntitiesArray != null && dimOrderLightEntitiesArray.Any())
7+
var dimOrderLightsArray = dimmerOptions.DimOrderLights?.ToArray();
8+
if (dimOrderLightsArray != null && dimOrderLightsArray.Any())
99
{
10-
var extraEntities = dimOrderLightEntitiesArray.Where(l => l != lightId).ToArray();
10+
var extraEntities = dimOrderLightsArray.Where(l => l != lightId).ToArray();
1111
if (extraEntities.Any())
1212
{
1313
throw new InvalidOperationException(
@@ -18,24 +18,24 @@ public static void ValidateSingleLight(this DimmerOptions dimmerOptions, string
1818

1919
public static OrderedDictionary<string, T> ValidateAndOrderMultipleLightTypes<T>(this DimmerOptions dimmerOptions, Dictionary<string, T> typesByLightIds)
2020
{
21-
var dimOrderLightEntitiesArray = dimmerOptions.DimOrderLightEntities?.ToArray();
22-
if (dimOrderLightEntitiesArray != null && dimOrderLightEntitiesArray.Any())
21+
var dimOrderLightsArray = dimmerOptions.DimOrderLights?.ToArray();
22+
if (dimOrderLightsArray != null && dimOrderLightsArray.Any())
2323
{
24-
var missingEntities = typesByLightIds.Keys.Except(dimOrderLightEntitiesArray).ToArray();
24+
var missingEntities = typesByLightIds.Keys.Except(dimOrderLightsArray).ToArray();
2525
if (missingEntities.Any())
2626
{
2727
throw new InvalidOperationException(
2828
$"When providing dim order, all entities should be provided. The following entities are missing: {string.Join(", ", missingEntities)}. Make sure to provide low level entities.");
2929
}
3030

31-
var extraEntities = dimOrderLightEntitiesArray.Except(typesByLightIds.Keys).ToArray();
31+
var extraEntities = dimOrderLightsArray.Except(typesByLightIds.Keys).ToArray();
3232
if (extraEntities.Any())
3333
{
3434
throw new InvalidOperationException(
3535
$"Pipeline does not contain the following entities: {string.Join(", ", extraEntities)}. Make sure to provide low level entities.");
3636
}
3737

38-
return new OrderedDictionary<string, T>(dimOrderLightEntitiesArray
38+
return new OrderedDictionary<string, T>(dimOrderLightsArray
3939
.Select(e => new KeyValuePair<string, T>(e, typesByLightIds[e])));
4040
}
4141

src/CodeCasa.AutomationPipelines.Lights/Pipeline/CompositeLightTransitionPipelineConfigurator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,10 @@ public ILightTransitionPipelineConfigurator ForLights(IEnumerable<string> lightI
106106
}
107107

108108
/// <inheritdoc/>
109-
public ILightTransitionPipelineConfigurator ForLights(IEnumerable<ILight> lightEntities,
109+
public ILightTransitionPipelineConfigurator ForLights(IEnumerable<ILight> lights,
110110
Action<ILightTransitionPipelineConfigurator> compositeNodeBuilder)
111111
{
112-
var lightIds = CompositeHelper.ResolveGroupsAndValidateLightsSupported(lightEntities, NodeContainers.Keys);
112+
var lightIds = CompositeHelper.ResolveGroupsAndValidateLightsSupported(lights, NodeContainers.Keys);
113113
return ForLights(lightIds, compositeNodeBuilder);
114114
}
115115
}

src/CodeCasa.AutomationPipelines.Lights/Pipeline/ILightTransitionPipelineConfigurator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ public partial interface ILightTransitionPipelineConfigurator
8989
/// <summary>
9090
/// Creates a scoped pipeline configuration for multiple light entities.
9191
/// </summary>
92-
/// <param name="lightEntities">The light entities to configure.</param>
92+
/// <param name="lights">The light entities to configure.</param>
9393
/// <param name="compositeNodeBuilder">An action to configure the pipeline for these lights.</param>
9494
/// <returns>The configurator instance for method chaining.</returns>
95-
ILightTransitionPipelineConfigurator ForLights(IEnumerable<ILight> lightEntities, Action<ILightTransitionPipelineConfigurator> compositeNodeBuilder);
95+
ILightTransitionPipelineConfigurator ForLights(IEnumerable<ILight> lights, Action<ILightTransitionPipelineConfigurator> compositeNodeBuilder);
9696
}

src/CodeCasa.AutomationPipelines.Lights/Pipeline/LightPipelineFactory.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ internal IPipeline<LightTransition> CreateLightPipeline(ILight light, Action<ILi
4343
/// <summary>
4444
/// Creates light pipelines for multiple light entities.
4545
/// </summary>
46-
/// <param name="lightEntities">The light entities to create pipelines for.</param>
46+
/// <param name="lights">The light entities to create pipelines for.</param>
4747
/// <param name="pipelineBuilder">An action to configure the pipeline behavior.</param>
4848
/// <returns>A dictionary mapping light IDs to their corresponding pipelines.</returns>
49-
internal Dictionary<string, IPipeline<LightTransition>> CreateLightPipelines(IEnumerable<ILight> lightEntities, Action<ILightTransitionPipelineConfigurator> pipelineBuilder)
49+
internal Dictionary<string, IPipeline<LightTransition>> CreateLightPipelines(IEnumerable<ILight> lights, Action<ILightTransitionPipelineConfigurator> pipelineBuilder)
5050
{
5151
// Note: we simply assume that these are not groups.
52-
var lightArray = lightEntities.ToArray();
52+
var lightArray = lights.ToArray();
5353
if (!lightArray.Any())
5454
{
5555
return new Dictionary<string, IPipeline<LightTransition>>();

src/CodeCasa.AutomationPipelines.Lights/Pipeline/LightTransitionPipelineConfigurator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,10 @@ public ILightTransitionPipelineConfigurator ForLights(IEnumerable<string> lightI
102102
}
103103

104104
/// <inheritdoc/>
105-
public ILightTransitionPipelineConfigurator ForLights(IEnumerable<ILight> lightEntities,
105+
public ILightTransitionPipelineConfigurator ForLights(IEnumerable<ILight> lights,
106106
Action<ILightTransitionPipelineConfigurator> compositeNodeBuilder)
107107
{
108-
CompositeHelper.ResolveGroupsAndValidateLightSupported(lightEntities, Light.Id);
108+
CompositeHelper.ResolveGroupsAndValidateLightSupported(lights, Light.Id);
109109
return this;
110110
}
111111

src/CodeCasa.AutomationPipelines.Lights/ReactiveNode/CompositeLightTransitionReactiveNodeConfigurator.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ public ILightTransitionReactiveNodeConfigurator AddUncoupledDimmer(IDimmer dimme
6464
var configuratorsInOrder = options.ValidateAndOrderMultipleLightTypes(configurators).Select(kvp => kvp.Value).ToArray();
6565
foreach (var configurator in configuratorsInOrder)
6666
{
67-
var lightEntitiesInDimOrder = configuratorsInOrder.Select(c => c.Light);
68-
configurator.AddDimPulses(options, lightEntitiesInDimOrder, dimPulses, brightenPulses);
67+
var lightsInDimOrder = configuratorsInOrder.Select(c => c.Light);
68+
configurator.AddDimPulses(options, lightsInDimOrder, dimPulses, brightenPulses);
6969
}
7070
return this;
7171

@@ -111,9 +111,9 @@ public ILightTransitionReactiveNodeConfigurator ForLights(IEnumerable<string> li
111111
}
112112

113113
/// <inheritdoc/>
114-
public ILightTransitionReactiveNodeConfigurator ForLights(IEnumerable<ILight> lightEntities, Action<ILightTransitionReactiveNodeConfigurator> configure)
114+
public ILightTransitionReactiveNodeConfigurator ForLights(IEnumerable<ILight> lights, Action<ILightTransitionReactiveNodeConfigurator> configure)
115115
{
116-
var lightIds = CompositeHelper.ResolveGroupsAndValidateLightsSupported(lightEntities, configurators.Keys);
116+
var lightIds = CompositeHelper.ResolveGroupsAndValidateLightsSupported(lights, configurators.Keys);
117117
return ForLights(lightIds, configure);
118118
}
119119
}

0 commit comments

Comments
 (0)