mattercontrol/SlicerConfiguration/Settings/SettingsHelpers.cs
John Lewin 72deb94de3 Better convey that ChangeID expects a deviceToken param
- Avoid recovery - use PrinterSettings.LoadFile rather than ProfileManager.LoadProfile
2016-08-12 13:29:22 -07:00

470 lines
No EOL
16 KiB
C#

/*
Copyright (c) 2016, Lars Brubaker, John Lewin
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using MatterHackers.Agg.UI;
using MatterHackers.Localizations;
using MatterHackers.MatterControl.ConfigurationPage.PrintLeveling;
using MatterHackers.MatterControl.PrinterCommunication;
using MatterHackers.VectorMath;
using Newtonsoft.Json;
using MatterHackers.Agg.PlatformAbstract;
namespace MatterHackers.MatterControl.SlicerConfiguration
{
public static class SettingsKey
{
public const string auto_connect = nameof(auto_connect);
public const string baud_rate = nameof(baud_rate);
public const string bed_shape = nameof(bed_shape);
public const string bed_size = nameof(bed_size);
public const string bed_temperature = nameof(bed_temperature);
public const string bottom_clip_amount = nameof(bottom_clip_amount);
public const string build_height = nameof(build_height);
public const string cancel_gcode = nameof(cancel_gcode);
public const string center_part_on_bed = nameof(center_part_on_bed);
public const string com_port = nameof(com_port);
public const string connect_gcode = nameof(connect_gcode);
public const string created_date = nameof(created_date);
public const string default_material_presets = nameof(default_material_presets);
public const string device_token = nameof(device_token);
public const string device_type = nameof(device_type);
public const string extruder_count = nameof(extruder_count);
public const string resume_is_enabled = nameof(resume_is_enabled);
public const string extruders_share_temperature = nameof(extruders_share_temperature);
public const string filament_cost = nameof(filament_cost);
public const string filament_density = nameof(filament_density);
public const string filament_diameter = nameof(filament_diameter);
public const string fill_density = nameof(fill_density);
public const string first_layer_extrusion_width = nameof(first_layer_extrusion_width);
public const string first_layer_height = nameof(first_layer_height);
public const string has_fan = nameof(has_fan);
public const string has_hardware_leveling = nameof(has_hardware_leveling);
public const string has_heated_bed = nameof(has_heated_bed);
public const string bed_remove_part_temperature = nameof(bed_remove_part_temperature);
public const string has_power_control = nameof(has_power_control);
public const string has_sd_card_reader = nameof(has_sd_card_reader);
public const string layer_height = nameof(layer_height);
public const string layer_to_pause = nameof(layer_to_pause);
public const string make = nameof(make);
public const string min_fan_speed = nameof(min_fan_speed);
public const string model = nameof(model);
public const string nozzle_diameter = nameof(nozzle_diameter);
public const string perimeter_start_end_overlap = nameof(perimeter_start_end_overlap);
public const string print_center = nameof(print_center);
public const string printer_name = nameof(printer_name);
public const string publish_bed_image = nameof(publish_bed_image);
public const string resume_position_before_z_home = nameof(resume_position_before_z_home);
public const string windows_driver = nameof(windows_driver);
public const string z_homes_to_max = nameof(z_homes_to_max);
public const string active_theme_index = nameof(active_theme_index);
public const string show_reset_connection = nameof(show_reset_connection);
public const string spiral_vase = nameof(spiral_vase);
public const string start_gcode = nameof(start_gcode);
public const string oem_profile_token = nameof(oem_profile_token);
public const string layer_name = nameof(layer_name);
};
public class SettingsHelpers
{
private PrinterSettings printerSettings;
public SettingsHelpers(PrinterSettings printerSettings)
{
this.printerSettings = printerSettings;
}
public string ExtruderTemperature(int extruderIndex)
{
if (extruderIndex >= printerSettings.MaterialSettingsKeys.Count)
{
// MaterialSettingsKeys is empty or lacks a value for the given extruder index
//
// If extruder index zero was requested, return the layer cascade temperature value, otherwise null
return (extruderIndex == 0) ? printerSettings.GetValue("temperature") : null;
}
string materialKey = printerSettings.MaterialSettingsKeys[extruderIndex];
if (extruderIndex == 0 && (string.IsNullOrEmpty(materialKey) || printerSettings.UserLayer.ContainsKey("temperature")))
{
// In the case where a user override exists or MaterialSettingsKeys is populated with multiple extruder
// positions but position 0 is empty and thus unassigned, use layer cascade to resolve temp
return printerSettings.GetValue("temperature");
}
// Otherwise, use the SettingsLayers that is bound to this extruder
PrinterSettingsLayer layer = printerSettings.GetMaterialLayer(materialKey);
string result = "0";
layer?.TryGetValue("temperature", out result);
return result;
}
public int[] LayerToPauseOn()
{
string[] userValues = printerSettings.GetValue("layer_to_pause").Split(';');
int temp;
return userValues.Where(v => int.TryParse(v, out temp)).Select(v =>
{
//Convert from 0 based index to 1 based index
int val = int.Parse(v);
// Special case for user entered zero that pushes 0 to 1, otherwise val = val - 1 for 1 based index
return val == 0 ? 1 : val - 1;
}).ToArray();
}
internal double ParseDouble(string firstLayerValueString)
{
double firstLayerValue;
if (!double.TryParse(firstLayerValueString, out firstLayerValue))
{
throw new Exception(string.Format("Format cannot be parsed. FirstLayerHeight '{0}'", firstLayerValueString));
}
return firstLayerValue;
}
public void SetMarkedForDelete(bool markedForDelete)
{
var printerInfo = ProfileManager.Instance.ActiveProfile;
if (printerInfo != null)
{
printerInfo.MarkedForDelete = markedForDelete;
ProfileManager.Instance.Save();
}
// Clear selected printer state
UserSettings.Instance.set("ActiveProfileID", "");
UiThread.RunOnIdle(() => ActiveSliceSettings.Instance = ProfileManager.LoadEmptyProfile());
}
public void SetBaudRate(string baudRate)
{
printerSettings.SetValue(SettingsKey.baud_rate, baudRate);
}
public string ComPort()
{
return printerSettings.GetValue($"{Environment.MachineName}_com_port");
}
public void SetComPort(string port)
{
printerSettings.SetValue($"{Environment.MachineName}_com_port", port);
}
public void SetComPort(string port, PrinterSettingsLayer layer)
{
printerSettings.SetValue($"{Environment.MachineName}_com_port", port, layer);
}
public void SetSlicingEngine(string engine)
{
printerSettings.SetValue("slicing_engine", engine);
}
public void SetDriverType(string driver)
{
printerSettings.SetValue("driver_type", driver);
}
public void SetDeviceToken(string token)
{
if (printerSettings.GetValue(SettingsKey.device_token) != token)
{
printerSettings.SetValue(SettingsKey.device_token, token);
}
}
public void SetName(string name)
{
printerSettings.SetValue(SettingsKey.printer_name, name);
}
public void SetManualMovementSpeeds(string speed)
{
printerSettings.SetValue("manual_movement_speeds", speed);
}
private PrintLevelingData printLevelingData = null;
public PrintLevelingData GetPrintLevelingData()
{
if (printLevelingData == null)
{
printLevelingData = PrintLevelingData.Create(
ActiveSliceSettings.Instance,
printerSettings.GetValue("print_leveling_data"),
printerSettings.GetValue("MatterControl.PrintLevelingProbePositions"));
PrintLevelingPlane.Instance.SetPrintLevelingEquation(
printLevelingData.SampledPosition0,
printLevelingData.SampledPosition1,
printLevelingData.SampledPosition2,
ActiveSliceSettings.Instance.GetValue<Vector2>(SettingsKey.print_center));
}
return printLevelingData;
}
public void SetPrintLevelingData(PrintLevelingData data)
{
printLevelingData = data;
printerSettings.SetValue("print_leveling_data", JsonConvert.SerializeObject(data));
}
public void DoPrintLeveling(bool doLeveling)
{
// Early exit if already set
if (doLeveling == printerSettings.GetValue<bool>("print_leveling_enabled"))
{
return;
}
printerSettings.SetValue("print_leveling_enabled", doLeveling ? "1" : "0");
PrinterSettings.PrintLevelingEnabledChanged?.CallEvents(this, null);
if (doLeveling)
{
PrintLevelingData levelingData = ActiveSliceSettings.Instance.Helpers.GetPrintLevelingData();
PrintLevelingPlane.Instance.SetPrintLevelingEquation(
levelingData.SampledPosition0,
levelingData.SampledPosition1,
levelingData.SampledPosition2,
ActiveSliceSettings.Instance.GetValue<Vector2>(SettingsKey.print_center));
}
}
public Vector2 ExtruderOffset(int extruderIndex)
{
string currentOffsets = printerSettings.GetValue("extruder_offset");
string[] offsets = currentOffsets.Split(',');
int count = 0;
foreach (string offset in offsets)
{
if (count == extruderIndex)
{
string[] xy = offset.Split('x');
return new Vector2(double.Parse(xy[0]), double.Parse(xy[1]));
}
count++;
}
return Vector2.Zero;
}
private static readonly SlicingEngineTypes defaultEngineType = SlicingEngineTypes.MatterSlice;
public SlicingEngineTypes ActiveSliceEngineType()
{
List<SliceEngineInfo> availableEnginens = SlicingQueue.AvailableSliceEngines;
if (OsInformation.OperatingSystem == OSType.Android
|| availableEnginens.Count == 1)
{
// android only has MatterSlice available, so always return it.
return SlicingEngineTypes.MatterSlice;
}
string engineType = printerSettings.GetValue("slicing_engine");
if (string.IsNullOrEmpty(engineType))
{
return defaultEngineType;
}
var engine = (SlicingEngineTypes)Enum.Parse(typeof(SlicingEngineTypes), engineType);
return engine;
}
public void ActiveSliceEngineType(SlicingEngineTypes type)
{
printerSettings.SetValue("slicing_engine", type.ToString());
}
public SliceEngineMapping ActiveSliceEngine()
{
switch (ActiveSliceEngineType())
{
case SlicingEngineTypes.CuraEngine:
return EngineMappingCura.Instance;
case SlicingEngineTypes.MatterSlice:
return EngineMappingsMatterSlice.Instance;
case SlicingEngineTypes.Slic3r:
return Slic3rEngineMappings.Instance;
default:
return null;
}
}
public void ExportAsMatterControlConfig()
{
FileDialog.SaveFileDialog(
new SaveFileDialogParams("MatterControl Printer Export|*.printer", title: "Export Printer Settings")
{
FileName = printerSettings.GetValue(SettingsKey.printer_name)
},
(saveParams) =>
{
if (!string.IsNullOrWhiteSpace(saveParams.FileName))
{
File.WriteAllText(saveParams.FileName, JsonConvert.SerializeObject(printerSettings, Formatting.Indented));
}
});
}
public void ExportAsSlic3rConfig()
{
FileDialog.SaveFileDialog(
new SaveFileDialogParams("Save Slice Configuration".Localize() + "|*.ini")
{
FileName = printerSettings.GetValue(SettingsKey.printer_name)
},
(saveParams) =>
{
if (!string.IsNullOrWhiteSpace(saveParams.FileName))
{
GenerateConfigFile(saveParams.FileName, false);
}
});
}
public void GenerateConfigFile(string fileName, bool replaceMacroValues)
{
using (var outstream = new StreamWriter(fileName))
{
// TODO: No longer valid to check for leading MatterControl. token
foreach (var key in PrinterSettings.KnownSettings.Where(k => !k.StartsWith("MatterControl.")))
{
string activeValue = printerSettings.GetValue(key);
if (replaceMacroValues)
{
activeValue = GCodeProcessing.ReplaceMacroValues(activeValue);
}
outstream.Write(string.Format("{0} = {1}\n", key, activeValue));
activeValue = GCodeProcessing.ReplaceMacroValues(activeValue);
}
}
}
public void ExportAsCuraConfig()
{
throw new NotImplementedException();
}
public Vector3 ManualMovementSpeeds()
{
Vector3 feedRate = new Vector3(3000, 3000, 315);
string savedSettings = ActiveSliceSettings.Instance.GetValue("manual_movement_speeds");
if (!string.IsNullOrEmpty(savedSettings))
{
var segments = savedSettings.Split(',');
feedRate.x = double.Parse(segments[1]);
feedRate.y = double.Parse(segments[3]);
feedRate.z = double.Parse(segments[5]);
}
return feedRate;
}
public Dictionary<string, double> GetMovementSpeeds()
{
Dictionary<string, double> speeds = new Dictionary<string, double>();
string movementSpeedsString = GetMovementSpeedsString();
string[] allSpeeds = movementSpeedsString.Split(',');
for (int i = 0; i < allSpeeds.Length / 2; i++)
{
speeds.Add(allSpeeds[i * 2 + 0], double.Parse(allSpeeds[i * 2 + 1]));
}
return speeds;
}
public string GetMovementSpeedsString()
{
string presets = "x,3000,y,3000,z,315,e0,150"; // stored x,value,y,value,z,value,e1,value,e2,value,e3,value,...
if (PrinterConnectionAndCommunication.Instance != null)
{
string savedSettings = printerSettings.GetValue("manual_movement_speeds");
if (!string.IsNullOrEmpty(savedSettings))
{
presets = savedSettings;
}
}
return presets;
}
}
public class PrinterInfo
{
public string ComPort { get; set; }
public string ID { get; set; }
public string Name { get; set; }
public string Make { get; set; }
public string Model { get; set; }
public string DeviceToken { get; set; }
public bool IsDirty { get; set; } = false;
public bool MarkedForDelete { get; set; } = false;
public string SHA1 { get; set; }
public void ChangeID(string deviceToken)
{
if (ActiveSliceSettings.Instance.ID == this.ID)
{
ActiveSliceSettings.Instance.ID = deviceToken;
}
string existingProfile = ProfilePath;
if (File.Exists(existingProfile))
{
this.ID = deviceToken;
File.Move(existingProfile, ProfilePath);
}
var profile = PrinterSettings.LoadFile(ProfilePath);
profile.ID = deviceToken;
profile.SetValue(SettingsKey.device_token, deviceToken);
ProfileManager.Instance.Save();
}
[JsonIgnore]
public string ProfilePath => ProfileManager.Instance.ProfilePath(this);
}
}