Jump to content

Template:Boilerplate-Datasheet: Difference between revisions

From SOJI ELECTRONICS
[checked revision][checked revision]
← Older edit
Admin (talk | contribs)
Bureaucrats, Interface administrators, Administrators
1,203 edits
VisualWikitext
No edit summary
Update
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
{{TemplateData
{{TemplateData
|description=Boilerplate template for product datasheet pages following SOJI standard structure. Yellow placeholders auto-hide when filled.
|description=Boilerplate template for product datasheet pages following SOJI standard structure.
}}
}}
</noinclude><includeonly>
 
== Product Overview ==
7 mandatory sections (== H2 ==):
{{Placeholder|e.g., The [Product Name] is a [type] device designed for [primary application]. It features [key technology] and is built for [target environment]. Include product name, category, primary function, and key value proposition in 1–2 paragraphs.}}
# Product Overview
# Key Features
# Applications
# Product Variants / Ordering Information
# Technical Specifications
# Compliance and Certifications
# Related Documents
 
[[Category:Boilerplates]]
</noinclude><includeonly>== Product Overview ==
<div class="dim">
 
''Brief 1–2 paragraph introduction to the product per IEC/IEEE 82079-1.''
 
'''What to fill in:'''
* Product name, category, primary function
* Key technology and target environment
* Value proposition for B2B customers
 
'''Example structure:''' "The [Product Name] is a [type] device designed for [primary application]. It features [key technology] and is built for [target environment]."
 
</div>


== Key Features ==
== Key Features ==
* {{Placeholder|e.g., Ultrasonic fuel level measurement with ±0.3% accuracy}}
<div class="dim">
* {{Placeholder|e.g., Bluetooth 5.0 LE connectivity, range up to 50m line-of-sight}}
 
* {{Placeholder|e.g., 5+ years battery life on a single CR2 battery}}
''Bullet list of top 5–7 differentiating features.''
* {{Placeholder|e.g., IP67 rated for outdoor industrial environments}}
 
* {{Placeholder|e.g., Compatible with standard fleet telematics platforms}}
'''What to fill in:'''
* Each bullet = 1 key feature with measurable value
* Focus on: accuracy, connectivity, durability, compatibility
* Examples of features to cover:
** Measurement specifications (accuracy, range, response time)
** Connectivity (Bluetooth/WiFi/Cellular protocol + version)
** Power (battery life, voltage range)
** Environmental rating (IP, operating temperature)
** Compatibility (telematics platforms, software)
 
</div>


== Applications ==
== Applications ==
* {{Placeholder|e.g., Commercial truck and fleet vehicle fuel monitoring}}
<div class="dim">
* {{Placeholder|e.g., Backup generator monitoring at telecom sites}}
* {{Placeholder|e.g., Industrial storage tank level tracking}}
* {{Placeholder|e.g., Marine bunker fuel monitoring}}


== Product Variants / Ordering Information ==
''Typical use cases and industries the product serves.''
{| class="wikitable"
|-
! Model !! Part Number !! Description !! Region
|-
| {{Placeholder|e.g., LIGO-AIR-STD}} || {{Placeholder|e.g., SKU-001}} || {{Placeholder|e.g., Standard cabled variant, 2m cable}} || {{Placeholder|e.g., Global}}
|-
| {{Placeholder|e.g., LIGO-AIR-EXT}} || {{Placeholder|e.g., SKU-002}} || {{Placeholder|e.g., Extended cable variant, 5m cable}} || {{Placeholder|e.g., EU/APAC}}
|-
| {{Placeholder|e.g., LIGO-AIR-IND}} || {{Placeholder|e.g., SKU-003}} || {{Placeholder|e.g., Industrial-grade with ATEX certification}} || {{Placeholder|e.g., Global}}
|}


== Technical Specifications ==
'''What to fill in:''' bullet list of applications (4–6 items)
* Each bullet = 1 specific industry/use case
* Common categories:
** Transportation/Fleet (trucks, buses, trailers)
** Telecom (backup generators, base stations)
** Industrial (storage tanks, process monitoring)
** Marine (bunker fuel, hydraulic systems)
** Mining (heavy equipment, refueling stations)


=== Performance ===
</div>
{| class="wikitable"
|-
! Parameter !! Value !! Unit !! Notes
|-
| Operating frequency || {{Placeholder|e.g., 40}} || kHz || {{Placeholder|e.g., Ultrasonic transducer frequency}}
|-
| Sampling rate || {{Placeholder|e.g., 1 / 5 / 10}} || Hz || {{Placeholder|e.g., Configurable via app}}
|-
| Measurement accuracy || {{Placeholder|e.g., ±0.3}} || % FS || {{Placeholder|e.g., Full-scale at room temperature}}
|-
| Measurement range || {{Placeholder|e.g., 30 – 2000}} || mm || {{Placeholder|e.g., Min – max distance}}
|-
| Response time || {{Placeholder|e.g., < 200}} || ms || {{Placeholder|e.g., Time to stable reading}}
|-
| Resolution || {{Placeholder|e.g., 1}} || mm || {{Placeholder|e.g., Smallest detectable change}}
|}


=== Electrical ===
== Product Variants / Ordering Information ==
{| class="wikitable"
<div class="dim">
|-
! Parameter !! Min !! Typ !! Max !! Unit !! Notes
|-
| Operating voltage || {{Placeholder|e.g., 9}} || {{Placeholder|e.g., 12}} || {{Placeholder|e.g., 32}} || V || {{Placeholder|e.g., DC, reverse-polarity protected}}
|-
| Operating current (active) || — || {{Placeholder|e.g., 25}} || {{Placeholder|e.g., 80}} || mA || {{Placeholder|e.g., During measurement}}
|-
| Sleep current || — || {{Placeholder|e.g., 5}} || {{Placeholder|e.g., 15}} || µA || {{Placeholder|e.g., Between measurements}}
|-
| Peak current (TX burst) || — || — || {{Placeholder|e.g., 150}} || mA || {{Placeholder|e.g., BLE transmit peak}}
|-
| Battery (if applicable) || colspan="3" align="center" | {{Placeholder|e.g., 1× CR2 lithium, 3 V, 800 mAh}} || — || {{Placeholder|e.g., Field-replaceable}}
|-
| Service life || colspan="3" align="center" | {{Placeholder|e.g., 5 years @ 1 reading/min}} || — || {{Placeholder|e.g., Typical operating conditions}}
|}


=== Wireless / Radio ===
''Table of all product SKUs available for ordering.''
{| class="wikitable"
|-
! Parameter !! Specification
|-
| Standard || {{Placeholder|e.g., Bluetooth 5.0 LE}}
|-
| Frequency band || {{Placeholder|e.g., 2.402 – 2.480 GHz (ISM)}}
|-
| Output power (max) || {{Placeholder|e.g., +4 dBm}}
|-
| Receiver sensitivity || {{Placeholder|e.g., −95 dBm}}
|-
| Antenna type || {{Placeholder|e.g., Internal PCB antenna}}
|-
| Range (line-of-sight) || {{Placeholder|e.g., 50 m typical, 100 m with high-gain accessory}}
|-
| Pairing security || {{Placeholder|e.g., LE Secure Connections, AES-128}}
|}


''Remove this sub-section if the product has no wireless capability.''
'''What to fill in:''' table with columns:
* '''Model''' — short product code (e.g., LIGO-AIR-STD)
* '''Part Number''' — internal SKU (e.g., SKU-001)
* '''Description''' — variant differences (cable length, certification, etc.)
* '''Region''' — geographic availability (Global, EU/APAC, US only, etc.)


=== Environmental ===
'''Common variants:''' Standard / Extended / Industrial-grade / ATEX-certified
{| class="wikitable"
|-
! Parameter !! Min !! Max !! Unit
|-
| Operating temperature || {{Placeholder|e.g., −40}} || {{Placeholder|e.g., +85}} || °C
|-
| Storage temperature || {{Placeholder|e.g., −40}} || {{Placeholder|e.g., +85}} || °C
|-
| Operating humidity || {{Placeholder|e.g., 5}} || {{Placeholder|e.g., 95}} || % RH (non-cond.)
|-
| Ingress protection || colspan="2" align="center" | {{Placeholder|e.g., IP67}} || per IEC 60529
|-
| Vibration resistance || colspan="2" align="center" | {{Placeholder|e.g., 5 g, 10–500 Hz}} || per IEC 60068-2-6
|-
| Shock resistance || colspan="2" align="center" | {{Placeholder|e.g., 50 g, 11 ms}} || per IEC 60068-2-27
|}


=== Memory / Storage ===
</div>
{| class="wikitable"
|-
! Type !! Size !! Notes
|-
| Flash memory || {{Placeholder|e.g., 512 KB}} || {{Placeholder|e.g., Firmware storage}}
|-
| RAM || {{Placeholder|e.g., 128 KB}} || {{Placeholder|e.g., Runtime}}
|-
| EEPROM / Config storage || {{Placeholder|e.g., 4 KB}} || {{Placeholder|e.g., Calibration + settings}}
|-
| Log buffer || {{Placeholder|e.g., 1000 records}} || {{Placeholder|e.g., Local data logging}}
|}


''Remove this sub-section if not relevant to the product.''
== Technical Specifications ==
<div class="dim">


=== Mechanical Dimensions ===
''Detailed technical parameters of the product.''
{| class="wikitable"
|-
! Parameter !! Value !! Unit
|-
| Length || {{Placeholder|e.g., 120}} || mm
|-
| Width || {{Placeholder|e.g., 80}} || mm
|-
| Height || {{Placeholder|e.g., 35}} || mm
|-
| Weight (excl. cable) || {{Placeholder|e.g., 180}} || g
|-
| Cable length || {{Placeholder|e.g., 2}} || m
|-
| Mounting interface || colspan="2" align="center" | {{Placeholder|e.g., 4× M5 holes, 100×60 mm spacing}}
|}


[[File:Product-dimensions.png|thumb|center|400px|{{Placeholder|e.g., Mechanical dimensions drawing (mm)}}]]
'''What to fill in:''' specification table with columns Parameter / Value / Unit / Descriptions


=== Interface / Connectivity ===
'''Parameters to cover:'''
{| class="wikitable"
* '''Electrical''': Operating voltage, Operating current (avg/peak/sleep), Power consumption
|-
* '''Performance''': Measurement range, Accuracy, Resolution, Response time, Sampling rate
! Interface !! Specification
* '''Wireless''' (if applicable): Protocol, Frequency band, Output power, Receiver sensitivity, Range
|-
* '''Environmental''': Operating temperature, Storage temperature, Humidity, Ingress protection (IP)
| Power connector || {{Placeholder|e.g., 4-pin M12 A-coded, IP67}}
* '''Mechanical''': Dimensions (L × W × H), Weight, Mounting interface
|-
* '''Service life''': Expected years at typical operation
| Data interface || {{Placeholder|e.g., RS485 (Modbus RTU) + BLE}}
|-
| Configuration interface || {{Placeholder|e.g., USB Type-C (Service port, hidden)}}
|-
| Status indicator || {{Placeholder|e.g., Multi-color LED (Power / Status / BLE)}}
|}


''Remove this sub-section if all interfaces are covered above.''
'''Optional sub-sections:''' If product has many specs, split into <code><nowiki>=== Performance ===</nowiki></code>, <code><nowiki>=== Electrical ===</nowiki></code>, <code><nowiki>=== Wireless ===</nowiki></code>, <code><nowiki>=== Environmental ===</nowiki></code>, <code><nowiki>=== Memory ===</nowiki></code>, <code><nowiki>=== Mechanical Dimensions ===</nowiki></code>, <code><nowiki>=== Interface / Connectivity ===</nowiki></code>, each with its own table.
 
</div>


== Compliance and Certifications ==
== Compliance and Certifications ==
<div class="dim">
''Regulatory certifications and standards compliance.''


=== Wireless / Radio ===
'''What to fill in (sub-sections):'''
* CE RED (EU) — {{Placeholder|e.g., certificate number}}
* FCC Part 15 (US) — {{Placeholder|e.g., FCC ID 2AXXX-XXXX}}
* IC (Canada) — {{Placeholder|e.g., IC number 12345A-XXXX}}
* Bluetooth SIG QDID — {{Placeholder|e.g., QDID 123456}}
* RoHS 3 (Directive 2015/863/EU)


=== Environmental ===
* '''Wireless / Radio''' — bullet list of certifications by region:
* RoHS 3 (Directive 2015/863/EU)
** CE RED (EU) — certificate number
* REACH (EC 1907/2006)
** FCC Part 15 (US) — FCC ID
* WEEE (Directive 2012/19/EU)
** IC (Canada) — IC number
* IP rating: {{Placeholder|e.g., IP67 per IEC 60529}}
** Bluetooth SIG QDID (if BLE)
** RoHS 3


=== Mechanical / Safety ===
* '''Environmental''' — standards compliance:
* IEC 60068-2-6 — Vibration test
** RoHS 3 (Directive 2015/863/EU)
* IEC 60068-2-27 — Shock test
** REACH (EC 1907/2006)
* IEC 60068-2-30 — Damp heat cyclic
** WEEE (Directive 2012/19/EU)
* IEC 61010-1 — Safety requirements for electrical equipment
** IP rating per IEC 60529


=== Industry-Specific ===
* '''Mechanical / Safety''' — test standards:
* {{Placeholder|e.g., ATEX / IECEx — Zone 2 II 3G Ex nA IIC T4 Gc}}
** IEC 60068-2-6 — Vibration
* {{Placeholder|e.g., MID (Measuring Instruments Directive) — if used for trade}}
** IEC 60068-2-27 — Shock
* {{Placeholder|e.g., Automotive E-Mark — E1 R10}}
** IEC 60068-2-30 — Damp heat
* {{Placeholder|e.g., Marine certification — DNV / ABS / Lloyd's Register}}
** IEC 61010-1 — Electrical safety


''Remove items that don't apply to the product.''
* '''Industry-Specific''' (remove if N/A):
** ATEX / IECEx — for hazardous environments
** MID — Measuring Instruments Directive
** Automotive E-Mark — for vehicle applications
** Marine certification — DNV / ABS / Lloyd's Register


=== Warranty ===
* '''Warranty''':
* '''Standard warranty''': {{Placeholder|e.g., 2}} years from date of shipment
** Standard warranty period (years from shipment)
* '''Extended warranty available''': {{Placeholder|e.g., 5}} years (optional)
** Extended warranty options
* '''Warranty terms''': see [[Warranty Terms and Conditions]]
** NOT covered items
** Void conditions
** Cross-reference to [[Warranty Terms and Conditions]]


</div>
<div class="noprint">
== Related Documents ==
== Related Documents ==
* [[User Guide|User Guide]]
''Cross-references to other documents.''
* [[Certification & Approvals|Certification & Approvals]]
{{RelatedDocuments}}
* [[Frequently Asked Questions - FAQ|FAQ]]
</div>
* {{Placeholder|e.g., [[Media:Product-Mechanical-Drawing.pdf|Mechanical Drawing PDF]]}}
* {{Placeholder|e.g., [[Media:Product-Declaration-of-Conformity.pdf|EU Declaration of Conformity]]}}


== Revision History ==
== Revision History ==
{| class="wikitable"
<div class="revision-history-auto">
|-
<span class="dim">Loading revision history...</span>
! Version !! Date !! Author !! Changes
</div>
|-
| 1.0 || {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}} || {{Placeholder|e.g., Cuongnv}} || Initial release
|-
| 1.1 || {{Placeholder|e.g., 2026-06-15}} || {{Placeholder|e.g., Author name}} || {{Placeholder|e.g., Updated electrical specs after revision B release}}
|}


{{Placeholder|Add product category below. Examples: [[Category:LIGO AIR]], [[Category:LIGO PRO]], [[Category:LIGO PRO BLE]],.... The page will appear under that product in CategoryTree and sidebar. Delete this hint after replacing the category line.}}
[[Category:{{subst:#replace:{{subst:PAGENAME}}| Datasheet|}}]]
[[Category:Main Page]]
</includeonly>
</includeonly>

Latest revision as of 09:01, 25 May 2026

Template:TemplateData

7 mandatory sections (== H2 ==):

  1. Product Overview
  2. Key Features
  3. Applications
  4. Product Variants / Ordering Information
  5. Technical Specifications
  6. Compliance and Certifications
  7. Related Documents
SOJI Electronics
Retrieved from "https://wiki.sojielectronics.com/index.php?title=Template:Boilerplate-Datasheet&oldid=1230"