Jump to content

Template:Boilerplate-Datasheet: Difference between revisions

From SOJI ELECTRONICS
[unchecked revision][checked revision]
← Older edit
Admin (talk | contribs)
Bureaucrats, Interface administrators, Administrators
1,203 edits
VisualWikitext
No edit summary
Update
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
This boilerplate creates a Datasheet page structure with 11 standard sections for technical products.
{{TemplateData
|description=Boilerplate template for product datasheet pages following SOJI standard structure.
}}
 
7 mandatory sections (== H2 ==):
# Product Overview
# Key Features
# Applications
# Product Variants / Ordering Information
# Technical Specifications
# Compliance and Certifications
# Related Documents


[[Category:Boilerplates]]
[[Category:Boilerplates]]
</noinclude><includeonly>__TOC__
</noinclude><includeonly>== Product Overview ==
<div class="dim">


''Brief 1–2 paragraph introduction to the product per IEC/IEEE 82079-1.''


== Product Overview ==
'''What to fill in:'''
* Product name, category, primary function
* Key technology and target environment
* Value proposition for B2B customers


''1-2 paragraphs describing what the product is, its operating principle, and what makes it different from competitors.''
'''Example structure:''' "The [Product Name] is a [type] device designed for [primary application]. It features [key technology] and is built for [target environment]."


''Example: PRODUCT_NAME is a [type of device] designed by SOJI Electronics for [primary use case]. The device uses [technology/mechanism] to [function], transmitting data via [communication method]. The [housing/design] provides [protection level] for [operating environment].''
</div>


== Key Features ==
== Key Features ==
<div class="dim">
''Bullet list of top 5–7 differentiating features.''


* Feature 1 (concise, scannable)
'''What to fill in:'''
* Feature 2
* Each bullet = 1 key feature with measurable value
* Feature 3
* Focus on: accuracy, connectivity, durability, compatibility
* Feature 4
* Examples of features to cover:
* Feature 5
** Measurement specifications (accuracy, range, response time)
* Feature 6
** Connectivity (Bluetooth/WiFi/Cellular protocol + version)
** Power (battery life, voltage range)
** Environmental rating (IP, operating temperature)
** Compatibility (telematics platforms, software)


''Pattern: 1 line per feature, focus on benefits + key specs (e.g., "Battery life: 8-10 years", not "Uses Li-SOCl₂ chemistry").''
</div>


== Applications ==
== Applications ==
<div class="dim">


* Application area 1 (e.g., Heavy-duty trucks)
''Typical use cases and industries the product serves.''
* Application area 2
* Application area 3
* Application area 4
* Application area 5


== Product Variants / Ordering Information ==
'''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)


=== Product Variants ===
</div>


{| class="wikitable"
== Product Variants / Ordering Information ==
! Variant !! Description !! Use Case
<div class="dim">
|-
| Variant A || ... || ...
|-
| Variant B || ... || ...
|-
| Variant C || ... || ...
|}
 
=== Part Numbers ===
 
{| class="wikitable"
! Part Number !! Description !! Specification
|-
| PRODUCT-XXX-001 || Standard version || ...
|-
| PRODUCT-XXX-002 || Extended version || ...
|}
 
=== Ordering ===
 
* '''MOQ''': ... units
* '''Lead time''': ... weeks (standard), ... weeks (custom)
* '''Where to buy''': contact@sojielectronics.com or authorized distributors
* '''Custom versions''': Available on request
 
== Functional Overview / Block Diagram ==
 
''Brief description of internal architecture and how components interact.''
 
[[File:PRODUCT-block-diagram.png|center|600px|alt=Block diagram showing internal components]]
 
''Diagram shows:''
* Main MCU / processor
* Sensing/measurement element
* Power management
* Communication interface
* Memory / storage
 
== Interface / Connector Overview ==
 
''If product has physical connectors, document pin assignments. For wireless-only products, describe wireless interface.''
 
=== Wireless Interface ===


{| class="wikitable"
''Table of all product SKUs available for ordering.''
! Parameter !! Specification
|-
| Protocol || Bluetooth Low Energy 5.x / Wi-Fi / etc.
|-
| Frequency || 2.4 GHz ISM band
|-
| Range || ... m (line-of-sight)
|}


=== Connector Pinout (if applicable) ===
'''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.)


{| class="wikitable"
'''Common variants:''' Standard / Extended / Industrial-grade / ATEX-certified
! Pin !! Name !! Type !! Description
|-
| 1 || VCC || Power || Supply voltage
|-
| 2 || GND || Power || Ground
|-
| 3 || ... || ... || ...
|}


''For wireless-only products: "This product has no external connectors. All communication is via [wireless protocol]."''
</div>


== Technical Specifications ==
== Technical Specifications ==
<div class="dim">


=== Performance ===
''Detailed technical parameters of the product.''
 
{| class="wikitable"
! Parameter !! Min !! Typ !! Max !! Unit
|-
| Measurement accuracy || — || ±0.5 || — || %
|-
| Resolution || — || ... || — || ...
|-
| Sampling rate || ... || ... || ... || Hz / s
|}
 
=== Electrical ===
 
{| class="wikitable"
! Parameter !! Min !! Typ !! Max !! Unit
|-
| Supply voltage || ... || ... || ... || V
|-
| Current (operating) || — || ... || ... || µA / mA
|-
| Current (sleep) || — || ... || ... || µA
|-
| Battery capacity || — || ... || — || mAh
|-
| Battery life (expected) || ... || ... || — || years
|}
 
=== Wireless ===
 
{| class="wikitable"
! Parameter !! Specification
|-
| Protocol || ...
|-
| Frequency band || ...
|-
| TX power (max) || ... dBm
|-
| Sensitivity || ... dBm
|-
| Modulation || ...
|-
| Data rate || ...
|}
 
=== Mechanical ===
 
{| class="wikitable"
! Parameter !! Value
|-
| Dimensions (L × W × H) || ... × ... × ... mm
|-
| Weight || ... g
|-
| Housing material || ...
|-
| Cable length || ... mm (if applicable)
|}
 
=== Environmental ===
 
{| class="wikitable"
! Parameter !! Range
|-
| Operating temperature || ... °C to ... °C
|-
| Storage temperature || ... °C to ... °C
|-
| Humidity (operating) || ...% to ...% RH
|-
| Ingress protection || IPxx
|-
| Vibration resistance || IEC 60068-2-6
|-
| Shock resistance || ... G
|}
 
== Mechanical Dimensions ==
 
[[File:PRODUCT-dimensions.png|center|600px|alt=Overall dimensions in millimeters]]


''All dimensions in millimeters (mm). Tolerances: ± ... mm unless otherwise specified.''
'''What to fill in:''' specification table with columns Parameter / Value / Unit / Descriptions


=== Mounting Pattern ===
'''Parameters to cover:'''
* '''Electrical''': Operating voltage, Operating current (avg/peak/sleep), Power consumption
* '''Performance''': Measurement range, Accuracy, Resolution, Response time, Sampling rate
* '''Wireless''' (if applicable): Protocol, Frequency band, Output power, Receiver sensitivity, Range
* '''Environmental''': Operating temperature, Storage temperature, Humidity, Ingress protection (IP)
* '''Mechanical''': Dimensions (L × W × H), Weight, Mounting interface
* '''Service life''': Expected years at typical operation


[[File:PRODUCT-mounting-pattern.png|center|400px|alt=Mounting hole positions]]
'''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.


{| class="wikitable"
</div>
! Item !! Specification
|-
| Mounting holes || 4 × Ø... mm
|-
| Mounting hole spacing || ... × ... mm
|-
| Fastener type || M... screw
|}


== Compliance and Certifications ==
== Compliance and Certifications ==
<div class="dim">


=== Wireless / Radio ===
''Regulatory certifications and standards compliance.''
 
{| class="wikitable"
! Region !! Standard !! Status !! Reference
|-
| EU      || RED 2014/53/EU, EMC 2014/30/EU || ✓ Certified || CE DoC: ...
|-
| US      || FCC Part 15.247 || ✓ Certified || FCC ID: ...
|-
| Canada  || ISED RSS-247, ICES-003 || ✓ Certified || IC ID: ...
|-
| UK      || UKCA, UK RED || ✓ Certified || ...
|-
| Japan    || MIC (Telec) || ⏳ Pending / ✓ || ...
|}
 
=== Environmental ===


{| class="wikitable"
'''What to fill in (sub-sections):'''
! Standard !! Status
|-
| RoHS 3 (2011/65/EU + 2015/863) || ✓ Compliant
|-
| REACH (EC 1907/2006) || ✓ Compliant
|-
| WEEE (2012/19/EU) || ✓ Registered
|-
| Battery WEEE (if applicable) || ...
|}


=== Mechanical / Safety ===
* '''Wireless / Radio''' — bullet list of certifications by region:
** CE RED (EU) — certificate number
** FCC Part 15 (US) — FCC ID
** IC (Canada) — IC number
** Bluetooth SIG QDID (if BLE)
** RoHS 3


{| class="wikitable"
* '''Environmental''' — standards compliance:
! Standard !! Rating
** RoHS 3 (Directive 2015/863/EU)
|-
** REACH (EC 1907/2006)
| IEC 60529 (Ingress Protection) || IPxx
** WEEE (Directive 2012/19/EU)
|-
** IP rating per IEC 60529
| IEC 60068-2-6 (Vibration) || ...
|-
| IEC 60068-2-27 (Shock) || ...
|}


=== Industry-Specific ===
* '''Mechanical / Safety''' — test standards:
** IEC 60068-2-6 — Vibration
** IEC 60068-2-27 — Shock
** IEC 60068-2-30 — Damp heat
** IEC 61010-1 — Electrical safety


{| class="wikitable"
* '''Industry-Specific''' (remove if N/A):
! Membership / Standard !! Status
** ATEX / IECEx — for hazardous environments
|-
** MID — Measuring Instruments Directive
| Bluetooth SIG (if applicable) || ✓ Qualified — QDID: ...
** Automotive E-Mark — for vehicle applications
|-
** Marine certification — DNV / ABS / Lloyd's Register
| Wi-Fi Alliance (if applicable) || ...
|}


''For detailed certification documents, see [[Product Certification & Approvals]].''
* '''Warranty''':
** Standard warranty period (years from shipment)
** Extended warranty options
** NOT covered items
** Void conditions
** Cross-reference to [[Warranty Terms and Conditions]]


</div>
<div class="noprint">
== Related Documents ==
== Related Documents ==
 
''Cross-references to other documents.''
{| class="wikitable"
{{RelatedDocuments}}
! Document !! Version !! Description
</div>
|-
| [[Product User Guide]] || ... || Installation and operation instructions
|-
| [[Product Configuration]] || ... || Configuration parameters and protocol
|-
| [[Product Memberships]] || — || Industry memberships and qualifications
|-
| [[Product Certification & Approvals]] || — || Full certification list
|-
| [[Product Nomenclature, classification codes]] || — || HS / ECCN / part numbers
|-
| Application Note AN-001 || 1.0 || ''(if available)''
|-
| Mobile App User Guide || ... || ''(if applicable)''
|}


== Revision History ==
== Revision History ==
<div class="revision-history-auto">
<span class="dim">Loading revision history...</span>
</div>


{| class="wikitable"
[[Category:{{subst:#replace:{{subst:PAGENAME}}| Datasheet|}}]]
! Date !! Version !! Description
|-
| {{subst:#time:d/m/Y}} || 1.0 || Initial release
|}
 
----
 
''© {{subst:#time:Y}} SOJI Electronics JSC. All Rights Reserved.''
''Specifications subject to change without notice.''
 
[[Category:Datasheet]]
</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"