### Example Material Type Values Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Provides examples of specific material types or variants for the 'material_type' field. ```typescript material_type: "Silk" // Silk-finish PLA or other ``` ```typescript material_type: "CF" // Carbon fiber filled ``` ```typescript material_type: "GF" // Glass fiber filled ``` ```typescript material_type: "Metal-filled" // Metal-filled variant ``` ```typescript material_type: "Wood-filled" // Wood particle filled ``` ```typescript material_type: "Translucent" // Transparent or translucent ``` ```typescript material_type: "Matte" // Matte finish ``` ```typescript material_type: "Flexible" // Flexible TPU variant ``` -------------------------------- ### Minimum Viable Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/data-submission-guide.md Example of a JSON object representing the minimum required fields for a filament profile submission. ```json { "brand": "YourBrand", "material": "PLA", "material_type": "Standard", "color": "Black", "rgb": "#000000", "image": "https://example.com/image.jpg", "website": "https://example.com/product", "price_data": "19.99", "currency": "USD", "sku": "SKU-123", "upc": "123456789012" } ``` -------------------------------- ### Example FilamentProfile Initialization Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Demonstrates how to create a FilamentProfile instance with both required and optional fields populated. ```typescript const filament: FilamentProfile = { // Required fields brand: "Bambu Lab", material: "PLA", material_type: "Standard", color: "Red", rgb: "#FF0000", image: "https://example.com/images/bambu-pla-red.jpg", website: "https://bambulab.com/products/pla-red", price_data: "19.99", currency: "USD", sku: "PLA-RED-1KG", upc: "123456789012", // Optional fields datasheet_url: "https://example.com/datasheet.pdf", temp_min: 190, temp_max: 220, bed_temp_min: 50, bed_temp_max: 70, dry_temp_max: 45, dry_time: 4, density: 1240, diameter: 1750, nominal_weight: 1000, spool_weight: 150, fan_speed_min: 50, fan_speed_max: 100, flow_ratio: 1.0, glue: 0, ams: "ams,ams-lite,ams-2-pro", build_plate: "pei,textured-pei,cool" }; ``` -------------------------------- ### Light Ironing Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a filament profile configured for light ironing, specifying the ironing flow rate as a percentage of normal flow. ```typescript const lightIroningProfile: FilamentProfile = { material: "PLA", ironing_speed: 15, ironing_flow: 10, // 10% of normal flow // ... }; ``` -------------------------------- ### Standard Filament Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile configuration for a standard material, allowing for maximum fan speed. ```typescript // Standard material with full cooling option const standardProfile: FilamentProfile = { // ... fan_speed_max: 100, }; ``` -------------------------------- ### Moderate Ironing Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a filament profile configured for moderate ironing to achieve a premium finish, specifying the ironing flow rate. ```typescript const premiumIroningProfile: FilamentProfile = { // ... ironing_speed: 15, ironing_flow: 20, // 20% of normal flow }; ``` -------------------------------- ### Perfectly Calibrated Filament Flow Ratio Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile for perfectly calibrated filament, setting the flow_ratio to 1.0 for no adjustment. ```typescript // Perfectly calibrated filament const perfectProfile: FilamentProfile = { // ... flow_ratio: 1.0, // No adjustment }; ``` -------------------------------- ### Product Description Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Include a detailed description of the filament, highlighting features and uses. Defaults to null. ```typescript product_description: "High-quality, food-safe PLA with vibrant red color. Ideal for miniatures and fine detail prints. Excellent layer adhesion and minimal warping." ``` -------------------------------- ### Complete Filament Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md A comprehensive example demonstrating all available fields for a FilamentProfile object, covering required and optional product information, temperature settings, drying parameters, physical properties, print settings, and compatibility details. ```typescript const completeFilamentProfile: FilamentProfile = { // Required fields brand: "Bambu Lab", material: "PLA", material_type: "Silk", color: "Red", rgb: "#FF0000", image: "https://cdn.bambulab.com/pla-silk-red.jpg", website: "https://bambulab.com/products/pla-silk-red-1kg", price_data: "24.99", currency: "USD", sku: "PLA-SILK-RED-1KG", upc: "123456789012", // Optional product info upc_refill: "123456789013", datasheet_url: "https://bambulab.com/specs/pla-silk.pdf", product_description: "Premium silk-finish PLA with excellent surface quality and minimal layer lines.", // Temperature temp_min: 190, temp_max: 220, bed_temp_min: 50, bed_temp_max: 70, softening_temp: 65, // Drying dry_temp_max: 45, dry_time: 4, // Physical properties density: 1240, diameter: 1750, nominal_weight: 1000, spool_weight: 150, shrinkage: 0.5, // Print settings fan_speed_min: 50, fan_speed_max: 100, flow_ratio: 1.0, max_volumetric_speed: 15, k_value: 0.02, // Advanced ironing_speed: 15, ironing_flow: 10, glue: 0, // Compatibility ams: "ams,ams-lite,ams-2-pro", build_plate: "pei,textured-pei,cool", adapter_url: "https://bambulab.com/adapters/pla" }; ``` -------------------------------- ### Example Usage of ColorValue Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/types.md Provides an example of how to create a ColorValue object, specifying the color's name, hex code, and a descriptive text. ```typescript const color: ColorValue = { name: "Red", hex: "#FF0000", description: "Bright red suitable for visible prints" }; ``` -------------------------------- ### PETG Filament Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile configuration for PETG material, defining moderate fan speeds for balanced cooling. ```typescript const petgProfile: FilamentProfile = { material: "PETG", fan_speed_min: 30, fan_speed_max: 80, // ... }; ``` -------------------------------- ### Example AMS Type Configuration Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/configuration.md Demonstrates how to specify multiple compatible AMS module types for the 'ams' field. ```text "ams,ams-lite,ams-2-pro" ``` -------------------------------- ### ABS Filament Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile configuration for ABS material, setting minimal fan speeds to prevent warping. ```typescript const absProfile: FilamentProfile = { material: "ABS", fan_speed_min: 0, fan_speed_max: 20, // ... }; ``` -------------------------------- ### Datasheet URL Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Provide a stable URL to the technical datasheet, preferably a PDF. Defaults to null. ```typescript datasheet_url: "https://example.com/datasheets/pla-red-v2.pdf" ``` -------------------------------- ### Material Type Examples for Filament Profiles Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/configuration.md Provides examples of material modifiers or types that can be used with filament profiles. ```text Silk, CF, GF, Metal-filled, Wood-filled, Matte, Marble, Translucent, Carbon, Glow-in-the-dark, Magnetic, Conductive, High-Temperature ``` -------------------------------- ### CSV Format Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/data-submission-guide.md Example of filament data structured in CSV format. This is recommended for large datasets. ```csv brand,material,material_type,color,rgb,image,website,price_data,currency,sku,upc,temp_min,temp_max,bed_temp_min,bed_temp_max Bambu Lab,PLA,Standard,Red,#FF0000,https://example.com/pla-red.jpg,https://bambulab.com/pla-red,19.99,USD,PLA-RED-1KG,123456789012,190,220,50,70 Bambu Lab,PETG,Standard,Blue,#0000FF,https://example.com/petg-blue.jpg,https://bambulab.com/petg-blue,24.99,USD,PETG-BLU-1KG,123456789013,220,250,60,80 ``` -------------------------------- ### Example Build Plate Type Configuration Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/configuration.md Shows how to specify multiple compatible build plate types for the 'build_plate' field. ```text "pei,textured-pei,cool" ``` -------------------------------- ### TemperatureRange Usage Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/types.md Illustrates how to define nozzle and bed temperature ranges using the TemperatureRange interface. ```typescript const nozzleTemp: TemperatureRange = { min: 190, max: 220 }; const bedTemp: TemperatureRange = { min: 50, max: 70 }; ``` -------------------------------- ### JSON Format Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/data-submission-guide.md Example of filament data structured in JSON format. This is suitable for programmatic submission. ```json { "filaments": [ { "brand": "Bambu Lab", "material": "PLA", "material_type": "Standard", "color": "Red", "rgb": "#FF0000", "image": "https://example.com/pla-red.jpg", "website": "https://bambulab.com/pla-red", "price_data": "19.99", "currency": "USD", "sku": "PLA-RED-1KG", "upc": "123456789012", "temp_min": 190, "temp_max": 220, "bed_temp_min": 50, "bed_temp_max": 70 } ] } ``` -------------------------------- ### Generous Material Flow Ratio Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile for a material that extrudes heavily, setting a flow_ratio less than 1.0 to reduce extrusion. ```typescript // Filament that extrudes heavily const generousMaterialProfile: FilamentProfile = { // ... flow_ratio: 0.95, // 5% less extrusion }; ``` -------------------------------- ### PLA Filament Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile configuration for PLA material, specifying minimum and maximum fan speeds for optimal cooling. ```typescript const plaProfile: FilamentProfile = { material: "PLA", fan_speed_min: 50, fan_speed_max: 100, // ... }; ``` -------------------------------- ### Compatibility Usage Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/types.md Demonstrates how to define compatibility settings, including AMS types, build plate types, and an adapter URL. ```typescript const compat: Compatibility = { ams: ['ams', 'ams-lite', 'ams-2-pro'], build_plate: ['pei', 'textured-pei'], adapter_url: 'https://example.com/adapter-info' }; ``` -------------------------------- ### PETG Profile with Recommended Glue Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a filament profile for PETG, recommending the use of glue for improved bed adhesion. ```typescript // PETG - glue recommended const petgProfile: FilamentProfile = { material: "PETG", glue: 1, // Glue recommended for better adhesion // ... }; ``` -------------------------------- ### Thin Filament Flow Ratio Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile for thin filament requiring slightly more extrusion, setting a flow_ratio greater than 1.0. ```typescript // Filament that requires slightly more extrusion const thinFilamentProfile: FilamentProfile = { brand: "Generic", material: "PLA", flow_ratio: 1.05, // 5% more extrusion // ... }; ``` -------------------------------- ### Profile Requiring Glue Assistance Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a filament profile where glue is recommended for adhesion, indicated by 'glueMaybe'. ```typescript const difficultProfile: FilamentProfile = { // ... build_plate: "pei,glueMaybe", }; ``` -------------------------------- ### No Cooling Filament Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile configuration where no active cooling is applied, setting both minimum and maximum fan speeds to 0. ```typescript // No active cooling possible const noCoolingProfile: FilamentProfile = { // ... fan_speed_min: 0, fan_speed_max: 0, }; ``` -------------------------------- ### Field Mapping Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/data-submission-guide.md Illustrates mapping from a manufacturer's internal field names to the system's schema fields. ```text Your Column → System Field Product SKU → sku Brand Name → brand Type → material Variant → material_type Product Name → color Color Code → rgb Image URL → image Website URL → website List Price → price_data Currency → currency UPC/Barcode → upc ``` -------------------------------- ### Standard Profile with No Adapter URL Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a standard filament profile where no special adapters are needed, indicated by a null adapter_url. ```typescript const standardProfile: FilamentProfile = { material: "PLA", adapter_url: null, // ... }; ``` -------------------------------- ### Specialty Filament Flow Ratio Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile for a specialty material requiring significant extrusion adjustment, setting a higher flow_ratio. ```typescript // Material requiring significant adjustment const specialtyProfile: FilamentProfile = { // ... flow_ratio: 1.15, // 15% more extrusion }; ``` -------------------------------- ### Usage Example for AMS Compatibility Check Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Demonstrates how to use the `isCompatibleWithAMS` function with a sample filament profile object. ```typescript // Usage const profile = { ams: "ams,ams-lite,ams-2-pro" }; isCompatibleWithAMS(profile.ams, "ams"); // true isCompatibleWithAMS(profile.ams, "ams-ht"); // false ``` -------------------------------- ### Create Filament Profile (TypeScript) Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/README.md Example of creating a filament profile object in TypeScript, including required and recommended fields. ```typescript const filamentProfile: FilamentProfile = { // Required fields brand: "Bambu Lab", material: "PLA", material_type: "Silk", color: "Red", rgb: "#FF0000", image: "https://cdn.bambulab.com/pla-silk-red.jpg", website: "https://bambulab.com/products/pla-silk-red-1kg", price_data: "24.99", currency: "USD", sku: "PLA-SILK-RED-1KG", upc: "123456789012", // Optional but recommended temp_min: 190, temp_max: 220, bed_temp_min: 50, bed_temp_max: 70, density: 1240, diameter: 1750, nominal_weight: 1000, spool_weight: 150, fan_speed_min: 50, fan_speed_max: 100, flow_ratio: 1.0, glue: 0, ams: "ams,ams-lite,ams-2-pro", build_plate: "pei,textured-pei,cool" }; ``` -------------------------------- ### Example Material Values Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Shows valid uppercase string values for the 'material' field, representing standard filament compositions. ```typescript material: "PLA" // Polylactic Acid ``` ```typescript material: "ABS" // Acrylonitrile Butadiene Styrene ``` ```typescript material: "PETG" // Polyethylene Terephthalate Glycol ``` ```typescript material: "TPU" // Thermoplastic Polyurethane ``` -------------------------------- ### Price Data Examples Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Specify the current retail price as a numeric string. Use two decimal places for currency and omit currency symbols. ```typescript price_data: "19.99" // Standard 1kg spool price_data: "9.99" // Smaller spool price_data: "49.99" // Multi-pack price_data: "100.00" // Premium specialty filament ``` -------------------------------- ### Flexible TPU Filament Settings Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/temperature-settings.md Example of setting minimum and maximum nozzle temperatures for flexible TPU filament. ```typescript const tpuProfile: FilamentProfile = { // ... temp_min: 210, temp_max: 230, }; ``` -------------------------------- ### Sensitive Material Filament Profile Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a FilamentProfile configuration for a material sensitive to excessive cooling, limiting the maximum fan speed. ```typescript // Material sensitive to excessive cooling const sensitiveProfile: FilamentProfile = { // ... fan_speed_max: 50, }; ``` -------------------------------- ### Example Brand Values Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Illustrates valid string values for the 'brand' field, which must match registered brand names. ```typescript brand: "Bambu Lab" ``` ```typescript brand: "Prusa" ``` ```typescript brand: "Creality" ``` ```typescript brand: "Anycubic" ``` ```typescript brand: "MatterHackers" ``` -------------------------------- ### Currency Code Examples Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Indicate the currency for the price using a 3-letter ISO 4217 code. Ensure it is uppercase and matches the price. ```typescript currency: "USD" // United States Dollar currency: "EUR" // Euro currency: "GBP" // British Pound currency: "JPY" // Japanese Yen currency: "CAD" // Canadian Dollar currency: "AUD" // Australian Dollar ``` -------------------------------- ### Material Density Examples Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/physical-properties.md Examples of defining filament profiles with varying material densities, including standard, filled, and composite materials. Density is specified in milligrams per cubic centimeter (mg/cm³). ```typescript const plaProfile: FilamentProfile = { material: "PLA", density: 1240, // 1.24 g/cm³ // ... }; ``` ```typescript const plaCFProfile: FilamentProfile = { material: "PLA", material_type: "CF", density: 1350, // 1.35 g/cm³ // ... }; ``` ```typescript const absProfile: FilamentProfile = { material: "ABS", density: 1040, // 1.04 g/cm³ // ... }; ``` ```typescript const plaWoodProfile: FilamentProfile = { material: "PLA", material_type: "Wood-filled", density: 1120, // 1.12 g/cm³ // ... }; ``` -------------------------------- ### High-Temperature Nylon Filament Settings Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/temperature-settings.md Example of setting minimum and maximum nozzle temperatures for high-temperature nylon filament. ```typescript const nylonProfile: FilamentProfile = { // ... temp_min: 250, temp_max: 280, }; ``` -------------------------------- ### Example Usage of GlueType Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/types.md Demonstrates how to set the `glue` field in a FilamentProfile object using the GlueType enumeration. ```typescript const profile: FilamentProfile = { // ... other fields glue: 1, // Glue recommended }; ``` -------------------------------- ### PLA Filament Temperature Settings Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/temperature-settings.md Example of setting minimum and maximum nozzle temperatures for PLA filament. ```typescript const plaProfile: FilamentProfile = { // ... temp_min: 190, temp_max: 220, }; ``` -------------------------------- ### Profile Requiring Cooling Adapter Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a filament profile that needs a cooling adapter, with a URL pointing to adapter details. ```typescript const fastCoolingProfile: FilamentProfile = { material: "PLA", adapter_url: "https://example.com/cooling-fans/high-speed-fan-adapter", // ... }; ``` -------------------------------- ### Unheated Bed for PLA Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/temperature-settings.md Example demonstrating the edge case of setting bed temperatures for PLA when an unheated bed is used. ```typescript const plaUnheatedProfile: FilamentProfile = { // ... bed_temp_min: 0, bed_temp_max: 30, }; ``` -------------------------------- ### Engineering Nylon Filament Profile Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/physical-properties.md Example of a typical physical property profile for Engineering Nylon filament. ```typescript { density: 1150, diameter: 1750, nominal_weight: 1000, spool_weight: 150, shrinkage: 3.0 } ``` -------------------------------- ### ISO 4217 Currency Codes Examples Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/configuration.md Lists common ISO 4217 currency codes with their corresponding country and currency names. ```text USD (United States Dollar) EUR (Euro) GBP (British Pound) JPY (Japanese Yen) CAD (Canadian Dollar) AUD (Australian Dollar) CHF (Swiss Franc) CNY (Chinese Yuan) INR (Indian Rupee) SGD (Singapore Dollar) ``` -------------------------------- ### SKU Examples Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Provide the manufacturer's Stock Keeping Unit. This alphanumeric string should uniquely identify the filament variant and be case-sensitive. ```typescript sku: "PLA-RED-1KG" sku: "PETG-BLK-500G" sku: "TPU-FLEX-250G-PINK" sku: "PR-PLA-Silk-Red-1kg" sku: "PLA_RF_1000G" ``` -------------------------------- ### Flexible TPU Filament Profile Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/physical-properties.md Example of a typical physical property profile for Flexible TPU filament. ```typescript { density: 1180, diameter: 1750, nominal_weight: 250, spool_weight: 80, shrinkage: 1.0 } ``` -------------------------------- ### ABS Profile with Required Glue Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a filament profile for ABS, mandating the use of glue for successful prints due to adhesion challenges. ```typescript // ABS - glue absolutely required const absProfile: FilamentProfile = { material: "ABS", glue: 2, // Glue required for successful prints // ... }; ``` -------------------------------- ### PLA Heated Bed Temperature Settings Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/temperature-settings.md Example of setting minimum and maximum heated bed temperatures for PLA filament. ```typescript const plaProfile: FilamentProfile = { // ... bed_temp_min: 50, bed_temp_max: 70, }; ``` -------------------------------- ### Profile for Single Build Plate Compatibility Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a filament profile specifying compatibility with only one specific build plate. ```typescript const singlePlateProfile: FilamentProfile = { // ... build_plate: "engineering", }; ``` -------------------------------- ### Example Usage of BuildPlateType Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/types.md Demonstrates assigning compatible build plate types to the `build_plate` field in a FilamentProfile. Multiple types can be listed as a comma-separated string. ```typescript const profile: FilamentProfile = { // ... other fields build_plate: "pei,textured-pei,cool", }; ``` -------------------------------- ### Example Color Values Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Shows descriptive string values for the 'color' field, representing the filament's visual appearance. ```typescript color: "Red" ``` ```typescript color: "Magenta / Purple" ``` ```typescript color: "Translucent Clear" ``` ```typescript color: "Neon Orange" ``` ```typescript color: "Matte Black" ``` ```typescript color: "Silver Metallic" ``` ```typescript color: "Rainbow" ``` -------------------------------- ### Refill UPC Example Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Optionally provide the UPC for a refill spool variant if it differs from the main product UPC. Defaults to null. ```typescript upc_refill: "123456789013" ``` -------------------------------- ### PLA Profile with No Glue Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/print-settings.md Example of a filament profile for PLA, indicating that no special bed adhesion (glue) is required. ```typescript // PLA - no adhesive needed const plaProfile: FilamentProfile = { material: "PLA", glue: 0, // ... }; ``` -------------------------------- ### PLA Filament Profile with Standard Build Plates Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a standard PLA filament profile specifying compatibility with common build plates. ```typescript const plaProfile: FilamentProfile = { material: "PLA", build_plate: "pei,textured-pei,cool,engineering", // ... }; ``` -------------------------------- ### Specialty Material Profile with AMS Adapter URL Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a specialty material profile that requires an AMS adapter, with a URL for adapter information. ```typescript const specialtyProfile: FilamentProfile = { material: "PA", ams: "ams-ht", adapter_url: "https://example.com/ams-adapters/high-temp-setup", // ... }; ``` -------------------------------- ### High-Temperature Nylon Compatibility Configuration Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Defines compatibility for high-temperature Nylon (PA), requiring the HT AMS and specific engineering build plates. Includes an example adapter URL for setup. ```typescript const paHTCompatibility: Compatibility = { ams: "ams-ht", build_plate: "engineering,cf,g10", adapter_url: "https://example.com/ams-ht-setup" }; ``` -------------------------------- ### UPC Examples Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Enter the Universal Product Code (12 or 13 numeric digits). This standardized barcode must uniquely identify the product variant. ```typescript upc: "123456789012" // 12-digit UPC upc: "1234567890128" // 13-digit EAN ``` -------------------------------- ### Example Usage of AMSType Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/types.md Shows how to assign compatible AMS types to the `ams` field in a FilamentProfile. Multiple types can be specified as a comma-separated string. ```typescript const profile: FilamentProfile = { // ... other fields ams: "ams,ams-lite,ams-2-pro", }; ``` -------------------------------- ### Filament Profile with Generic MMU Compatibility Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a filament profile object specifying compatibility with a generic Multi-Material Unit (MMU), not specific to Bambu Lab hardware. ```typescript const genericMMU: FilamentProfile = { // ... ams: "mmu", }; ``` -------------------------------- ### ABS Heated Bed Temperature Settings Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/temperature-settings.md Example of setting minimum and maximum heated bed temperatures for ABS filament, which requires a heated bed. ```typescript const absProfile: FilamentProfile = { // ... bed_temp_min: 80, bed_temp_max: 110, }; ``` -------------------------------- ### Example RGB Hex Color Code Values Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Illustrates valid hexadecimal RGB color codes for the 'rgb' field, used for UI display. ```typescript rgb: "#FF0000" // Pure red ``` ```typescript rgb: "#0000FF" // Pure blue ``` ```typescript rgb: "#00FF00" // Pure green ``` ```typescript rgb: "#FFA500" // Orange ``` ```typescript rgb: "#FF1493" // Deep pink ``` ```typescript rgb: "#D3D3D3" // Light gray ``` ```typescript rgb: "#000000" // Black ``` ```typescript rgb: "#FFFFFF" // White ``` -------------------------------- ### Specialty Material Compatibility Configuration Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Defines compatibility for specialty materials, requiring the MMU and an engineering build plate. Includes a custom adapter URL for specific setup. ```typescript const specialtyCompatibility: Compatibility = { ams: "mmu", build_plate: "engineering", adapter_url: "https://example.com/specialty-material-setup" }; ``` -------------------------------- ### Product Image URLs Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Provide a URL pointing to a product image. Ensure it's a valid HTTP/HTTPS URL returning an image file and meets dimension recommendations. ```typescript image: "https://cdn.example.com/filament-images/red-pla.jpg" image: "https://images.bambulab.com/products/pla-red-web.png" image: "https://example.com/products/petg-blue-1kg.jpg" ``` -------------------------------- ### Profile Absolutely Requiring Glue Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a filament profile where glue is mandatory for adhesion, indicated by 'glueNeeded'. ```typescript const glueRequiredProfile: FilamentProfile = { // ... build_plate: "pei,glueNeeded", }; ``` -------------------------------- ### Carbon-Filled Composite Filament Profile Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/physical-properties.md Example of a typical physical property profile for Carbon-Filled Composite filament. ```typescript { density: 1380, diameter: 1750, nominal_weight: 500, spool_weight: 100, shrinkage: 0.2 } ``` -------------------------------- ### Standard PLA Filament Profile Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/physical-properties.md Example of a typical physical property profile for Standard PLA filament. ```typescript { density: 1240, diameter: 1750, nominal_weight: 1000, spool_weight: 150, shrinkage: 0.5 } ``` -------------------------------- ### PrintSettings Interface Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/types.md Specifies recommended print parameters. Includes temperature ranges, fan speed, and flow ratio. ```typescript interface PrintSettings { nozzle_temp: TemperatureRange; bed_temp: TemperatureRange; chamber_temp?: number; fan_speed: { min: number; max: number; }; flow_ratio?: number; max_volumetric_speed?: number; } ``` -------------------------------- ### Adapter URL for Hardware Compatibility Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Provide a valid HTTP/HTTPS URL for additional information regarding required adapters, such as for AMS or other hardware. ```typescript adapter_url: "https://example.com/ams-adapters/specialty-materials" ``` -------------------------------- ### Product Website URLs Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Link to the specific product page on the manufacturer's website. The URL must be publicly accessible and stable. ```typescript website: "https://bambulab.com/products/pla-red" website: "https://shop.prusa3d.com/en/Filament/PrusaPLA-Red-1kg" website: "https://store.creality.com/products/creality-pla-red" ``` -------------------------------- ### Loading Brand Registry Data Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/brand-registry.md Asynchronously fetches and parses the logos.json file to retrieve the list of brand identifiers. Ensure the file path is correct. ```typescript async function loadBrandRegistry(): Promise { const response = await fetch('/logos/logos.json'); const data: LogosRegistry = await response.json(); return data.logos; } // Usage const brands = await loadBrandRegistry(); console.log(brands.length); // 342+ console.log(brands.includes('bambu-lab')); // true ``` -------------------------------- ### Build Plate Type Values for Compatibility Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/configuration.md Lists the valid entries for the 'build_plate' field, indicating compatible build plate types. ```text pei → Smooth PEI textured-pei → Textured PEI cool → Cool Plate engineering → Engineering Plate superTack → SuperTack Cool Plate cryrogrip → CryoGrip g10 → G10 Fiberglass cf → Carbon Fiber glueMaybe → Glue Recommended glueNeeded → Glue Required ``` -------------------------------- ### Compatibility Interface Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/types.md Defines printer and hardware compatibility information. Includes AMS, build plate types, and adapter URLs. ```typescript interface Compatibility { ams?: AMSType[]; build_plate?: BuildPlateType[]; adapter_url?: string; } ``` -------------------------------- ### ABS Filament Temperature Range Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/temperature-settings.md Example of defining the temperature range for ABS filament, including minimum and maximum nozzle temperatures. ```typescript const absProfile = { brand: "Creality", material: "ABS", temp_min: 220, temp_max: 250, // ... }; ``` -------------------------------- ### Compatible Build Plates Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/filament-profile.md Specify compatible build plate types for Bambu Lab printers using a comma-separated string. Ensure no spaces are used. ```typescript build_plate: "pei,textured-pei,cool" build_plate: "engineering,g10,cf" build_plate: "pei" ``` -------------------------------- ### TPU Filament Profile with Limited Build Plate Compatibility Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a flexible TPU filament profile compatible with only a few specific build plates. ```typescript const tpuProfile: FilamentProfile = { material: "TPU", build_plate: "pei,textured-pei", // ... }; ``` -------------------------------- ### Filament Profile with No AMS Compatibility Source: https://github.com/marksmakerspace/filament-profiles/blob/main/_autodocs/api-reference/compatibility.md Example of a filament profile object where the 'ams' field is set to null, indicating no compatibility with any AMS module. ```typescript const noAMS: FilamentProfile = { // ... ams: null, }; ```